Package jsonvalues
Class Key
- java.lang.Object
-
- jsonvalues.Key
-
- All Implemented Interfaces:
Comparable<Position>,Position
public final class Key extends Object implements Position
Represents the Key of a JsElem in a JsObj.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IndexasIndex()throws an UserError exception.KeyasKey()Returns this key.intcompareTo(Position o)compares this key with another given position.booleanequals(@Nullable Object that)Returns true if that is a key and both have the same name.inthashCode()Returns the hashcode of this key.booleanisIndex()Returns false.booleanisKey()Returns true.static Keyof(String key)Returns a new instance which represents a key with the given name in a json object.StringtoString()Returns the name of the key.
-
-
-
Field Detail
-
name
public final String name
name of the key.
-
-
Method Detail
-
of
public static Key of(String key)
Returns a new instance which represents a key with the given name in a json object. Any string, but null, can represent a key in a json object, even the empty string.- Parameters:
key- the given name of the key- Returns:
- a new Key object
-
compareTo
public int compareTo(Position o)
compares this key with another given position. If the given position is a key, both are compared lexicographically, if it's an index, both are compared numerically.- Specified by:
compareToin interfaceComparable<Position>- Specified by:
compareToin interfacePosition- Parameters:
o- the given position- Returns:
- 0 if they are equal, +1 if this is greater, -1 otherwise
-
asKey
public Key asKey()
Returns this key.
-
asIndex
public Index asIndex()
throws an UserError exception.
-
isIndex
public boolean isIndex()
Returns false.
-
toString
public String toString()
Returns the name of the key.
-
equals
public boolean equals(@Nullable Object that)
Returns true if that is a key and both have the same name.
-
-