com.github.fge.jsonschema.ref

Class JsonFragment

java.lang.Object

com.github.fge.jsonschema.ref.JsonFragment

All Implemented Interfaces:

Comparable<JsonFragment>

Direct Known Subclasses:

JsonPointer

public abstract class JsonFragment
extends Object
implements Comparable<JsonFragment>

Abstract class for fragment resolution

In a JSON Reference, a fragment can only be a JSON Pointer. All other fragments are illegal.

The only possibility for a non JSON Pointer fragment to appear is when inline addressing mode is used.

See Also:

IllegalFragment, JsonPointer, AddressingMode

Field Summary

Fields

Modifier and Type	Field and Description
protected String	asString This fragment as a string value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonFragment(String input) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(JsonFragment o)
boolean	equals(Object obj)
static JsonFragment	fromFragment(String fragment) The only static factory method to obtain a fragment
int	hashCode()
abstract boolean	isEmpty() Tell whether this fragment is empty
abstract boolean	isPointer() Tell whether this fragment is a valid JSON Pointer
abstract JsonNode	resolve(JsonNode node) Resolve this fragment against a given node
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

asString

protected final String asString

This fragment as a string value

Constructor Detail

JsonFragment

protected JsonFragment(String input)

Constructor

Parameters:

input - the input fragment

Method Detail

fromFragment

public static JsonFragment fromFragment(String fragment)

The only static factory method to obtain a fragment

Depending on the situation, this method will either return a JsonPointer or an IllegalFragment.

Parameters:

fragment - the fragment as a string

Returns:

the fragment

resolve

public abstract JsonNode resolve(JsonNode node)

Resolve this fragment against a given node

Parameters:

node - the node

Returns:

the result node (MissingNode if the fragment is not found)

isEmpty

public abstract boolean isEmpty()

Tell whether this fragment is empty

Returns:

true if this fragment is empty

See Also:

JsonRef.isAbsolute()

isPointer

public abstract boolean isPointer()

Tell whether this fragment is a valid JSON Pointer

Returns:

true if this fragment is an instance of JsonPointer

compareTo

public final int compareTo(JsonFragment o)

Specified by:

compareTo in interface Comparable<JsonFragment>

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object