Package com.networknt.schema.annotation

Class Annotation

java.lang.Object

com.networknt.schema.annotation.Annotation

public class Annotation
extends Object

The annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Annotation.Builder

Constructor Summary

Constructors

Constructor	Description
Annotation(String keyword, NodePath instanceLocation, SchemaLocation schemaLocation, NodePath evaluationPath, Object value)

Method Summary

Modifier and Type	Method	Description
static Annotation.Builder	builder()
boolean	equals(Object obj)
NodePath	getEvaluationPath()	The evaluation path, indicating how reference keywords such as "$ref" were followed to reach the absolute schema location.
NodePath	getInstanceLocation()	The instance location to which it is attached, as a JSON Pointer.
String	getKeyword()	The keyword that produces the annotation.
SchemaLocation	getSchemaLocation()	The schema location of the attaching keyword, as a IRI and JSON Pointer fragment.
<T> T	getValue()	The attached value(s).
int	hashCode()
boolean	isValid()
void	setValid(boolean valid)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Annotation

public Annotation(String keyword,
                  NodePath instanceLocation,
                  SchemaLocation schemaLocation,
                  NodePath evaluationPath,
                  Object value)

Method Detail

getKeyword

public String getKeyword()

The keyword that produces the annotation.

Returns:

the keyword

getInstanceLocation

public NodePath getInstanceLocation()

The instance location to which it is attached, as a JSON Pointer.

Returns:

the instance location

getSchemaLocation

public SchemaLocation getSchemaLocation()

The schema location of the attaching keyword, as a IRI and JSON Pointer fragment.

Returns:

the schema location

getEvaluationPath

public NodePath getEvaluationPath()

The evaluation path, indicating how reference keywords such as "$ref" were followed to reach the absolute schema location.

Returns:

the evaluation path

getValue

public <T> T getValue()

The attached value(s).

Type Parameters:

T - the value type

Returns:

the value

isValid

public boolean isValid()

setValid

public void setValid(boolean valid)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

builder

public static Annotation.Builder builder()