Class Obj

java.lang.Object

io.github.mxz_schwarz.parser.Obj

Direct Known Subclasses:

Arr, Bool, Map, Null, Num, Str

public abstract sealed class Obj
extends Object
permits Map<T>, Arr<T>, Str, Num<N>, Bool, Null

A wrapper abstract class that acts as the superclass for all JSON data types. This consists mainly of convenience methods to allow a client to perform less manual casting.

Constructor Summary

Constructors

Constructor	Description
Obj()

Method Summary

Modifier and Type	Method	Description
<N extends Number> Num<N>	asNum()	Pretty much casts this to a Num<N extends Number>
<E extends Obj> Arr<E>	castElems(Class<E> clazz)
<E extends Obj> Map<E>	castVals(Class<E> clazz)
boolean	equals(Object o)
int	hashCode()
boolean	toBool()	Returns a boolean when this represents a boolean.
<T extends Obj> List<T>	toList()	Returns a List<Obj> when this represents an array.
<E> List<E>	toList(Class<E> clazz)	Convenience method to cast each element in an array to a particular type.
<T extends Obj> Map<String,T>	toMap()	Returns a Map<String,Obj> when this represents a boolean.
<E> Map<String,E>	toMap(Class<E> clazz)
Object	toNull()	Returns null when this represents null.
<N extends Number> N	toNum()	Returns a Number when this represents a number.
Object	toStdLibObj()
String	toStr()	Returns a String when this represents a string.
String	toString()

Methods inherited from class Object

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

Constructor Details

Obj

public Obj()

Method Details

toNum

public <N extends Number> N toNum()
                           throws JSONException

Returns a Number when this represents a number.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't a Num.

asNum

public <N extends Number> Num<N> asNum()
                                throws JSONException

Pretty much casts this to a Num<N extends Number>

Type Parameters:

N - The generic Type of this instance.

Returns:

A Num<N extends Number> when this is a Num<N extends Number>.

Throws:

JSONException - When this is not a Num<N extends Number>

toStr

public String toStr()
             throws JSONException

Returns a String when this represents a string.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't a Str.

toBool

public boolean toBool()
               throws JSONException

Returns a boolean when this represents a boolean.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't a Bool.

toNull

public Object toNull()
              throws JSONException

Returns null when this represents null.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't Null.

toList

public <T extends Obj> List<T> toList()
                               throws JSONException

Returns a List<Obj> when this represents an array.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't a Arr.

toList

public <E> List<E> toList(Class<E> clazz)
                   throws JSONException

Convenience method to cast each element in an array to a particular type.

Type Parameters:

T - The desired generic type of the List being returned.

Parameters:

clazz - The Class object representing the desired type.

Returns:

A list with generic type T.

Throws:

JSONException - If this Obj is not an Arr or when not every element is a T.

castElems

public <E extends Obj> Arr<E> castElems(Class<E> clazz)
                                 throws JSONException

Throws:

JSONException

toMap

public <T extends Obj> Map<String,T> toMap()
                                    throws JSONException

Returns a Map<String,Obj> when this represents a boolean.

Returns:

The value wrapped in this.

Throws:

JSONException - When this isn't a Map.

toMap

public <E> Map<String,E> toMap(Class<E> clazz)
                        throws JSONException

Type Parameters:

T - The desired generic type of values in the Map

Parameters:

clazz - The Class object representing the desired type.

Returns:

A Map with gener

Throws:

JSONException - When this isn't a Map or when not every element is a T.

castVals

public <E extends Obj> Map<E> castVals(Class<E> clazz)
                                throws JSONException

Throws:

JSONException

toStdLibObj

public Object toStdLibObj()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object