dev.dejvokep.boostedyaml.route.implementation

Class SingleKeyRoute

java.lang.Object

dev.dejvokep.boostedyaml.route.implementation.SingleKeyRoute

All Implemented Interfaces:

Route

public class SingleKeyRoute
extends Object
implements Route

Represents a single-key route.

Constructor Summary

Constructors

Constructor and Description
SingleKeyRoute(Object key) Constructs a route from the given non-null key.

Method Summary

Modifier and Type	Method and Description
Route	add(Object key) Adds the given non-null key to the route and returns the new object.
boolean	equals(Object o)
Object	get(int i) Returns key at the given index.
int	hashCode()
String	join(char separator) Joins the route's keys with the given separator.
int	length() Returns the length of the route (backing array) - amount of keys forming the route.
Route	parent() Returns the parent route of this one.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.dejvokep.boostedyaml.route.Route

addTo, from, from, fromSingleKey, fromString, fromString, fromString

Constructor Detail

SingleKeyRoute

public SingleKeyRoute(@NotNull
                      Object key)

Constructs a route from the given non-null key. The given key must be immutable; if this cannot be achieved, it is required that the caller never modifies it.

As indicated, the given key cannot be null. Such attempt will result in a NullPointerException.

Parameters:

key - the single key in the route

See Also:

implementation information

Method Detail

join

@NotNull
public String join(char separator)

Description copied from interface: Route

Joins the route's keys with the given separator.

Specified by:

join in interface Route

Parameters:

separator - the separator to join with

Returns:

the joined route

length

public int length()

Description copied from interface: Route

Returns the length of the route (backing array) - amount of keys forming the route.

Specified by:

length in interface Route

Returns:

the length

get

@NotNull
public Object get(int i)

Description copied from interface: Route

Returns key at the given index. Always verify if the requested index is within the range of the backing array's length.

Specified by:

get in interface Route

Parameters:

i - the index

Returns:

the key at the given index

parent

@NotNull
public Route parent()

Description copied from interface: Route

Returns the parent route of this one. More formally, creates a new route and copies this route's backing array without the last element.

Per documentation of Route.from(Object...), invoking this method if Route.length() == 1 will throw an IllegalArgumentException.

Specified by:

parent in interface Route

Returns:

the parent route

add

@NotNull
public Route add(@NotNull
                           Object key)

Description copied from interface: Route

Adds the given non-null key to the route and returns the new object. The given key must be immutable; if this cannot be achieved, it is required that the caller never modifies it.

For example, if you add key 1 to route ["a", "b"], the resulting route will be represented by ["a", "b", 1].

More formally, copies this route's backing array (keys), adds the given key at the end and returns the new route.

Specified by:

add in interface Route

Parameters:

key - the key to add

Returns:

the new route with same keys as this one, except with the given key added as the last one

equals

public boolean equals(Object o)

Specified by:

equals in interface Route

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Route

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object