This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rdf.git
The following commit(s) were added to refs/heads/master by this push:
new 6e483ea5 Javadoc: Use {@code ...}
6e483ea5 is described below
commit 6e483ea5257df1a7317f0d031021d036b2179522
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jan 17 09:32:25 2024 -0500
Javadoc: Use {@code ...}
---
.../java/org/apache/commons/rdf/api/Dataset.java | 38 +++++++++++-----------
.../main/java/org/apache/commons/rdf/api/RDF.java | 2 +-
.../apache/commons/rdf/experimental/RDFParser.java | 4 +--
.../java/org/apache/commons/rdf/jena/JenaRDF.java | 4 +--
.../commons/rdf/jsonldjava/JsonLdGraphLike.java | 2 +-
.../java/org/apache/commons/rdf/rdf4j/RDF4J.java | 8 ++---
.../org/apache/commons/rdf/rdf4j/RDF4JGraph.java | 6 ++--
.../rdf/rdf4j/impl/InternalRDF4JFactory.java | 2 +-
.../commons/rdf/simple/DatasetGraphView.java | 2 +-
.../rdf/simple/experimental/AbstractRDFParser.java | 4 +--
10 files changed, 36 insertions(+), 36 deletions(-)
diff --git
a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Dataset.java
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Dataset.java
index 3441b105..f92726c7 100644
--- a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Dataset.java
+++ b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/Dataset.java
@@ -38,7 +38,7 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
* those supported by this dataset.
*
* @param graphName
- * The graph the quad belongs to, or <code>null</code> for the
+ * The graph the quad belongs to, or {@code null} for the
* default graph
* @param subject
* The quad subject
@@ -86,14 +86,14 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
*
* @param graphName
* The graph the quad belongs to, wrapped as an {@link Optional}
- * (<code>null</code> is a wildcard, {@link Optional#empty()} is
+ * ({@code null} is a wildcard, {@link Optional#empty()} is
* the default graph)
* @param subject
- * The quad subject (<code>null</code> is a wildcard)
+ * The quad subject ({@code null} is a wildcard)
* @param predicate
- * The quad predicate (<code>null</code> is a wildcard)
+ * The quad predicate ({@code null} is a wildcard)
* @param object
- * The quad object (<code>null</code> is a wildcard)
+ * The quad object ({@code null} is a wildcard)
* @return True if the dataset contains any quads that match the given
* pattern.
*/
@@ -132,7 +132,7 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
* The {@link Triple}s of the named graph are equivalent to the Quads of
* this Dataset which has the {@link Quad#getGraphName()} equal to the
* provided <code>graphName</code>, or equal to {@link Optional#empty()} if
- * the provided <code>graphName</code> is <code>null</code>.
+ * the provided <code>graphName</code> is {@code null}.
* <p>
* It is unspecified if modifications to the returned Graph are reflected
in
* this Dataset.
@@ -143,7 +143,7 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
* @see #getGraph()
* @see #getGraphNames()
* @param graphName
- * The name of the graph, or <code>null</code> for the default
+ * The name of the graph, or {@code null} for the default
* graph.
* @return The named Graph, or {@link Optional#empty()} if the dataset do
* not contain the named graph.
@@ -257,14 +257,14 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
*
* @param graphName
* The graph the quad belongs to, wrapped as an {@link Optional}
- * (<code>null</code> is a wildcard, {@link Optional#empty()} is
+ * ({@code null} is a wildcard, {@link Optional#empty()} is
* the default graph)
* @param subject
- * The quad subject (<code>null</code> is a wildcard)
+ * The quad subject ({@code null} is a wildcard)
* @param predicate
- * The quad predicate (<code>null</code> is a wildcard)
+ * The quad predicate ({@code null} is a wildcard)
* @param object
- * The quad object (<code>null</code> is a wildcard)
+ * The quad object ({@code null} is a wildcard)
* @return A {@link Iterable} that returns {@link Iterator} over the
* matching quads in the dataset
* @throws IllegalStateException
@@ -284,14 +284,14 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
*
* @param graphName
* The graph the quad belongs to, wrapped as an {@link Optional}
- * (<code>null</code> is a wildcard, {@link Optional#empty()} is
+ * ({@code null} is a wildcard, {@link Optional#empty()} is
* the default graph)
* @param subject
- * The quad subject (<code>null</code> is a wildcard)
+ * The quad subject ({@code null} is a wildcard)
* @param predicate
- * The quad predicate (<code>null</code> is a wildcard)
+ * The quad predicate ({@code null} is a wildcard)
* @param object
- * The quad object (<code>null</code> is a wildcard)
+ * The quad object ({@code null} is a wildcard)
*/
void remove(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject,
IRI predicate, RDFTerm object);
@@ -348,14 +348,14 @@ public interface Dataset extends AutoCloseable,
GraphLike<Quad> {
*
* @param graphName
* The graph the quad belongs to, wrapped as an {@link Optional}
- * (<code>null</code> is a wildcard, {@link Optional#empty()} is
+ * ({@code null} is a wildcard, {@link Optional#empty()} is
* the default graph)
* @param subject
- * The quad subject (<code>null</code> is a wildcard)
+ * The quad subject ({@code null} is a wildcard)
* @param predicate
- * The quad predicate (<code>null</code> is a wildcard)
+ * The quad predicate ({@code null} is a wildcard)
* @param object
- * The quad object (<code>null</code> is a wildcard)
+ * The quad object ({@code null} is a wildcard)
* @return A {@link Stream} over the matched quads.
*/
Stream<? extends Quad> stream(Optional<BlankNodeOrIRI> graphName,
BlankNodeOrIRI subject, IRI predicate,
diff --git a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDF.java
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDF.java
index dd19b48f..f9d85399 100644
--- a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDF.java
+++ b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/RDF.java
@@ -217,7 +217,7 @@ public interface RDF {
*
* @param graphName
* The IRI or BlankNode that this quad belongs to, or
- * <code>null</code> for the public graph
+ * {@code null} for the public graph
* @param subject
* The IRI or BlankNode that is the subject of the quad
* @param predicate
diff --git
a/commons-rdf-api/src/main/java/org/apache/commons/rdf/experimental/RDFParser.java
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/experimental/RDFParser.java
index 87e7633e..c25b46f7 100644
---
a/commons-rdf-api/src/main/java/org/apache/commons/rdf/experimental/RDFParser.java
+++
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/experimental/RDFParser.java
@@ -61,7 +61,7 @@ import org.apache.commons.rdf.api.Triple;
* Setting a method that has already been set will override any existing value
* in the returned builder - regardless of the parameter type (e.g.
* {@link #source(IRI)} will override a previous {@link #source(Path)}.
Settings
- * can be unset by passing <code>null</code> - note that this may require
+ * can be unset by passing {@code null} - note that this may require
* casting, e.g. <code>contentType( (RDFSyntax) null )</code> to undo a
previous
* call to {@link #contentType(RDFSyntax)}.
* <p>
@@ -213,7 +213,7 @@ public interface RDFParser {
* <p>
* The returned {@link Future} contains a {@link ParseResult}.
* Implementations may subclass this interface to provide any parser
- * details, e.g. list of warnings. <code>null</code> is a possible return
+ * details, e.g. list of warnings. {@code null} is a possible return
* value if no details are available, but parsing succeeded.
* <p>
* If an exception occurs during parsing, (e.g. {@link IOException} or
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDF.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDF.java
index 4d118311..d2f96560 100644
--- a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDF.java
+++ b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDF.java
@@ -651,7 +651,7 @@ public final class JenaRDF implements RDF {
* {@link QuadLike#getSubject()} {@link QuadLike#getPredicate()},
* {@link QuadLike#getObject()} or {@link QuadLike#getObject()}.
* <p>
- * In addition to supporting a <code>graphName</code> of <code>null</code>
+ * In addition to supporting a <code>graphName</code> of {@code null}
* for representing a triple in the <em>default graph</em>, this method
also
* recognize a {@link JenaIRI} which {@link JenaRDFTerm#asJenaNode()}
* represent the default graph according to
@@ -733,7 +733,7 @@ public final class JenaRDF implements RDF {
/**
* {@inheritDoc}
* <p>
- * In addition to supporting a <code>graphName</code> of <code>null</code>
+ * In addition to supporting a <code>graphName</code> of {@code null}
* for representing a triple in the <em>default graph</em>, this method
also
* recognize a {@link JenaIRI} which {@link JenaRDFTerm#asJenaNode()}
* represent the default graph according to
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdGraphLike.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdGraphLike.java
index 3a4abead..ce8bb45f 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdGraphLike.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdGraphLike.java
@@ -53,7 +53,7 @@ abstract class AbstractJsonLdGraphLike<T extends TripleLike>
implements JsonLdGr
/**
* The underlying JSON-LD {@link RDFDataset}.
* <p>
- * Note: This is NOT final as it is reset to <code>null</code> by
+ * Note: This is NOT final as it is reset to {@code null} by
* {@link #close()} (to free memory).
*/
RDFDataset rdfDataSet;
diff --git
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
index 05bf0a4f..1bf7127e 100644
--- a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
+++ b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
@@ -297,7 +297,7 @@ public final class RDF4J implements RDF {
* @param contexts
* A {@link Set} of {@link BlankNodeOrIRI} specifying the graph
* names to use as a context. The set may include the value
- * <code>null</code> to indicate the default graph. The empty
set
+ * {@code null} to indicate the default graph. The empty set
* indicates any context, e.g. the <em>union graph</em>.
* @param option
* Zero or more {@link Option}s
@@ -305,7 +305,7 @@ public final class RDF4J implements RDF {
*/
public RDF4JGraph asGraph(final Repository repository, final Set<? extends
BlankNodeOrIRI> contexts, final Option... option) {
final EnumSet<Option> opts = optionSet(option);
- /** NOTE: asValue() deliberately CAN handle <code>null</code> */
+ /** NOTE: asValue() deliberately CAN handle {@code null} */
final Resource[] resources = contexts.stream().map(g -> (Resource)
asValue(g)).toArray(Resource[]::new);
return
RDF4J.createRepositoryGraphImpl(Objects.requireNonNull(repository),
opts.contains(Option.handleInitAndShutdown),
opts.contains(Option.includeInferred), resources);
@@ -522,8 +522,8 @@ public final class RDF4J implements RDF {
* {@link org.apache.commons.rdf.api.Literal} is converted to a
* {@link org.eclipse.rdf4j.model.Literal}.
* <p>
- * If the provided {@link RDFTerm} is <code>null</code>, then the returned
- * value is <code>null</code>.
+ * If the provided {@link RDFTerm} is {@code null}, then the returned
+ * value is {@code null}.
* <p>
* If the provided term is an instance of {@link RDF4JTerm}, then the
* {@link RDF4JTerm#asValue()} is returned without any conversion. Note
that
diff --git
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java
index f25cf2c6..09282b0f 100644
---
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java
+++
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java
@@ -52,7 +52,7 @@ public interface RDF4JGraph extends Graph,
RDF4JGraphLike<Triple> {
* contexts, while retrieval (e.g. {@link #contains(Triple)}) will succeed
* if the triple is in at least one of the specified contexts.
* <p>
- * The context mask array may contain <code>null</code>, indicating the
+ * The context mask array may contain {@code null}, indicating the
* default context (the <em>default graph</em> in RDF datasets).
* <p>
* If the context mask is {@link Set#isEmpty()}, then this is a <em>union
@@ -60,13 +60,13 @@ public interface RDF4JGraph extends Graph,
RDF4JGraphLike<Triple> {
* added to the graph will be added in the default context, e.g. equivalent
* to <code>new Resource[1]{null}</code>) in RDF4J.
* <p>
- * Note that the context mask itself cannot be <code>null</code>.
+ * Note that the context mask itself cannot be {@code null}.
* <p>
* The returned set is an immutable copy; to specify a different mask, use
* {@link RDF4J#asGraph(Repository, Set, Option...)}
*
* @return The context mask as a set of {@link BlankNodeOrIRI} graph names,
- * which may contain the value <code>null</code>.
+ * which may contain the value {@code null}.
*/
Set<RDF4JBlankNodeOrIRI> getContextMask();
diff --git
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/impl/InternalRDF4JFactory.java
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/impl/InternalRDF4JFactory.java
index 03830b7d..31eb0eb7 100644
---
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/impl/InternalRDF4JFactory.java
+++
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/impl/InternalRDF4JFactory.java
@@ -156,7 +156,7 @@ public abstract class InternalRDF4JFactory {
* If true, any inferred quads are included in the dataset
* @param contextMask
* Zero or more {@link Resource}s contexts. The array may
contain
- * the value <code>null</code> for the default graph - however
+ * the value {@code null} for the default graph - however
* care must be taken to not provide a null-array
* <code>(Resource[]) null</code>.
* @return Adapted {@link RDF4JGraph}
diff --git
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/DatasetGraphView.java
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/DatasetGraphView.java
index 88ee5e16..7eede45b 100644
---
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/DatasetGraphView.java
+++
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/DatasetGraphView.java
@@ -43,7 +43,7 @@ import org.apache.commons.rdf.api.Triple;
*
* <dt>{@link #DatasetGraphView(Dataset, BlankNodeOrIRI)}</dt>
* <dd>Expose a particular graph of the Dataset, either named by an {@link
IRI},
- * a {@link BlankNode}, or <code>null</code> for the <em>default
+ * a {@link BlankNode}, or {@code null} for the <em>default
* graph</em>.</dd>
* </dl>
* <p>
diff --git
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/AbstractRDFParser.java
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/AbstractRDFParser.java
index 37bb50a6..ea7f42b7 100644
---
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/AbstractRDFParser.java
+++
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/AbstractRDFParser.java
@@ -363,9 +363,9 @@ public abstract class AbstractRDFParser<T extends
AbstractRDFParser<T>> implemen
* Gets the target to consume parsed Quads.
* <p>
* From the call to {@link #parseSynchronusly()}, this will be a
- * non-<code>null</code> value (as a target is a required setting).
+ * non-{@code null} value (as a target is a required setting).
*
- * @return The target consumer of {@link Quad}s, or <code>null</code> if it
+ * @return The target consumer of {@link Quad}s, or {@code null} if it
* has not yet been set.
*
*/
