Package com.apicatalog.jsonld.framing

Class Frame

java.lang.Object

com.apicatalog.jsonld.framing.Frame

public final class Frame
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static Frame	EMPTY

Method Summary

Modifier and Type	Method	Description
boolean	contains(String property)
boolean	containsOnly(String property)
jakarta.json.JsonValue	get(String property)
static boolean	getBoolean(jakarta.json.JsonObject frame, String key, boolean defaultValue)
Collection<jakarta.json.JsonValue>	getCollection(String property)
JsonLdEmbed	getEmbed(JsonLdEmbed defaultValue)
boolean	getExplicit(boolean defaultValue)
boolean	getRequireAll(boolean defaultValue)
boolean	isDefaultObject(String property)
boolean	isListObject()
boolean	isNodePattern()
boolean	isNodeReference()
boolean	isNone(String property)
boolean	isValuePattern()
boolean	isWildCard()
boolean	isWildCard(String property)
Set<String>	keys()
boolean	matchNode(FramingState state, jakarta.json.JsonValue value, boolean requireAll)
boolean	matchValue(jakarta.json.JsonValue value)
static Frame	of(jakarta.json.JsonStructure structure)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final Frame EMPTY

Method Detail

of

public static final Frame of(jakarta.json.JsonStructure structure)
                      throws JsonLdError

Throws:

JsonLdError

getEmbed

public JsonLdEmbed getEmbed(JsonLdEmbed defaultValue)
                     throws JsonLdError

Throws:

JsonLdError

getExplicit

public boolean getExplicit(boolean defaultValue)
                    throws JsonLdError

Throws:

JsonLdError

getRequireAll

public boolean getRequireAll(boolean defaultValue)
                      throws JsonLdError

Throws:

JsonLdError

getBoolean

public static final boolean getBoolean(jakarta.json.JsonObject frame,
                                       String key,
                                       boolean defaultValue)
                                throws JsonLdError

Throws:

JsonLdError

keys

public Set<String> keys()

get

public jakarta.json.JsonValue get(String property)

contains

public boolean contains(String property)

containsOnly

public boolean containsOnly(String property)

isWildCard

public boolean isWildCard()

isWildCard

public boolean isWildCard(String property)

isNone

public boolean isNone(String property)

getCollection

public Collection<jakarta.json.JsonValue> getCollection(String property)

toString

public String toString()

Overrides:

toString in class Object

isValuePattern

public boolean isValuePattern()

matchValue

public boolean matchValue(jakarta.json.JsonValue value)

isDefaultObject

public boolean isDefaultObject(String property)

isNodePattern

public boolean isNodePattern()

isNodeReference

public boolean isNodeReference()

matchNode

public boolean matchNode(FramingState state,
                         jakarta.json.JsonValue value,
                         boolean requireAll)
                  throws JsonLdError

Throws:

JsonLdError

isListObject

public boolean isListObject()