Package jsonvalues
Class Index
- java.lang.Object
-
- jsonvalues.Index
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IndexasIndex()Returns this index.KeyasKey()throws an UserError exception.intcompareTo(Position o)Compares this index with another given position.booleanequals(java.lang.Object that)Returns true if that is an index and both have the same value.inthashCode()Returns the hashcode of this index.booleanisIndex()Returns true.booleanisKey()Returns false.static Indexof(int index)Returns a new instance witch represents the given index in an array.java.lang.StringtoString()Returns the value of the index as a string.
-
-
-
Method Detail
-
of
public static Index of(int index)
Returns a new instance witch represents the given index in an array. The special index -1 points to the last element of an array.- Parameters:
index- the given position- Returns:
- an Index object
- Throws:
java.lang.IndexOutOfBoundsException- if the index is less than -1
-
compareTo
public int compareTo(Position o)
Compares this index with another given position. If the given position is an index, both are compared numerically, if it's a key, both are compared lexicographically.
-
asKey
public Key asKey()
throws an UserError exception.
-
asIndex
public Index asIndex()
Returns this index.
-
isIndex
public boolean isIndex()
Returns true.
-
isKey
public boolean isKey()
Returns false.
-
hashCode
public int hashCode()
Returns the hashcode of this index.- Overrides:
hashCodein classjava.lang.Object- Returns:
- the index value
-
equals
public boolean equals(java.lang.Object that)
Returns true if that is an index and both have the same value.- Overrides:
equalsin classjava.lang.Object- Parameters:
that- other object- Returns:
- true if both objects are indexes representing the same position
-
toString
public java.lang.String toString()
Returns the value of the index as a string.- Overrides:
toStringin classjava.lang.Object- Returns:
- the value of the index as a string
-
-