SnakeYAML 2.2 · org.yaml.snakeyaml.nodes.Tag

Field Summary

Modifier and Type	Field and Description
public static final Tag	BINARY
public static final Tag	BOOL
public static final Tag	COMMENT
private static final Map<Tag, Set<Class<?>>>	COMPATIBILITY_MAP
public static final Tag	FLOAT
public static final Tag	INT
public static final Tag	MAP
public static final Tag	MERGE
public static final Tag	NULL
public static final Tag	OMAP
public static final Tag	PAIRS
public static final String	PREFIX
private boolean	secondary
public static final Tag	SEQ
public static final Tag	SET
public static final Set<Tag>	standardTags
public static final Tag	STR
public static final Tag	TIMESTAMP
private final String	value
public static final Tag	YAML

Constructor Summary

Access	Constructor and Description
public	Tag(String tag)
public	Tag(Class<? extends Object> clazz)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getClassName()
public String	getValue()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: true when the Class can be represented by this language-independent tag isCompatible(Class<?> - Class to check compatibility clazz) Java has more than 1 class compatible with a language-independent tag (!!int, !!float, !!timestamp etc)
public boolean	Returns: true when the tag must be verified to avoid remote code invocation isCustomGlobal() Check if the that is global and not standard to provide it to TagInspector for verification.
public boolean	isSecondary()
public boolean	Returns: true when this tag can be used as a global tag for the Class during serialisation matches(Class<? extends Object> - Class to check clazz) Check whether this tag matches the global tag for the Class
public boolean	startsWith(String prefix)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

BINARY	back to summary
public static final Tag BINARY

BOOL	back to summary
public static final Tag BOOL

COMMENT	back to summary
public static final Tag COMMENT

COMPATIBILITY_MAP	back to summary
private static final Map<Tag, Set<Class<?>>> COMPATIBILITY_MAP

FLOAT	back to summary
public static final Tag FLOAT

INT	back to summary
public static final Tag INT

MAP	back to summary
public static final Tag MAP

MERGE	back to summary
public static final Tag MERGE

NULL	back to summary
public static final Tag NULL

OMAP	back to summary
public static final Tag OMAP

PAIRS	back to summary
public static final Tag PAIRS

PREFIX	back to summary
public static final String PREFIX

secondary	back to summary
private boolean secondary

SEQ	back to summary
public static final Tag SEQ

SET	back to summary
public static final Tag SET

standardTags	back to summary
public static final Set<Tag> standardTags

STR	back to summary
public static final Tag STR

TIMESTAMP	back to summary
public static final Tag TIMESTAMP

value	back to summary
private final String value

YAML	back to summary
public static final Tag YAML

Constructor Detail

Tag	back to summary
public Tag(String tag)

Tag	back to summary
public Tag(Class<? extends Object> clazz)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getClassName	back to summary
public String getClassName()

getValue	back to summary
public String getValue()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isCompatible	back to summary
public boolean isCompatible(Class<?> clazz) Java has more than 1 class compatible with a language-independent tag (!!int, !!float, !!timestamp etc) Parameters clazz:Class<?> - Class to check compatibility Returns:boolean true when the Class can be represented by this language-independent tag

isCompatible

back to summary

public boolean isCompatible(Class<?> clazz)

Java has more than 1 class compatible with a language-independent tag (!!int, !!float, !!timestamp etc)

Parameters

clazz:Class<?>: - Class to check compatibility

Returns:boolean

true when the Class can be represented by this language-independent tag

isCustomGlobal	back to summary
public boolean isCustomGlobal() Check if the that is global and not standard to provide it to TagInspector for verification. Returns:boolean true when the tag must be verified to avoid remote code invocation

isCustomGlobal

back to summary

public boolean isCustomGlobal()

Check if the that is global and not standard to provide it to TagInspector for verification.

Returns:boolean: true when the tag must be verified to avoid remote code invocation

isSecondary	back to summary
public boolean isSecondary()

matches	back to summary
public boolean matches(Class<? extends Object> clazz) Check whether this tag matches the global tag for the Class Parameters clazz:Class<? extends Object> - Class to check Returns:boolean true when this tag can be used as a global tag for the Class during serialisation

matches

back to summary

public boolean matches(Class<? extends Object> clazz)

Check whether this tag matches the global tag for the Class

Parameters

clazz:Class<? extends Object>: - Class to check

Returns:boolean

true when this tag can be used as a global tag for the Class during serialisation

startsWith	back to summary
public boolean startsWith(String prefix)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public final Class Tag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail