dev.dejvokep.boostedyaml.route.implementation

Class MultiKeyRoute

java.lang.Object

dev.dejvokep.boostedyaml.route.implementation.MultiKeyRoute

All Implemented Interfaces:

Route

public class MultiKeyRoute
extends Object
implements Route

Represents a multi-key route.

Constructor Summary

Constructors

Constructor and Description
MultiKeyRoute(Object... route) Constructs route from the given array of keys/key arguments, enabling usage of wide-range data types as keys.

Method Summary

Modifier and Type	Method and Description
Route	add(Object key) Creates a new route, copies this route's backing array, adds the given key at the end and returns the new route created from the new array.
boolean	equals(Object o)
Object	get(int i) Returns key in this route (from the backing array), at the given position.
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 this 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

MultiKeyRoute

public MultiKeyRoute(@NotNull
                     Object... route)

Constructs route from the given array of keys/key arguments, enabling usage of wide-range data types as keys. The given keys should be immutable; otherwise, it is required that the caller never modifies them.

The given array cannot contain null keys.

Empty array is considered illegal and will throw an IllegalArgumentException. Call with null supplied as the route argument (e.g. from((Object[]) null)) will throw a NullPointerException.

The given keys are traversed in order as they were specified - just like folders: assuming route ["x", 1], processor attempts to get section at key "x" in the section from which the getter/setter... method was called; and then value at key 1 in that section.

If varargs format is used and there is only one argument, it will automatically be interpreted as call to Route.from(Object), saving time and memory consumption.

If passing an array as the only key, do not forget to cast it to Object, otherwise it will be interpreted as multi-key route according to the array's contents. Alternatively, to avoid confusion, use Route.fromSingleKey(Object)

As routes are immutable objects, to save resources, it is recommended to create individual routes only once and then reuse them.

Parameters:

route - the route array

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 this route.

Specified by:

length in interface Route

Returns:

the length

get

@NotNull
public Object get(int i)

Description copied from interface: Route

Returns key in this route (from the backing array), at the given position. Always verify if the index is within the range of the backing array by calling Route.length().

Specified by:

get in interface Route

Parameters:

i - the index

Returns:

the key at the given index

add

@NotNull
public Route add(@NotNull
                           Object key)

Description copied from interface: Route

Creates a new route, copies this route's backing array, adds the given key at the end and returns the new route created from the new array.

The given key cannot be null, it is required to verify that.

It is in the caller's best interest to never modify the objects given (and their contents), as it might cause several issues (inequalities between routes...).

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 at the end

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.

Please note that if this route's Route.length() is 1, invoking this method will create an IllegalArgumentException, as it is illegal to have empty routes. See more at Route.from(Object...).

Specified by:

parent in interface Route

Returns:

the parent route of this 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