Package yapion

Class YAPIONUtils

java.lang.Object

yapion.YAPIONUtils

public class YAPIONUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YAPIONUtils.CheckResult

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FILE_ENDING	This is the default file ending associated by a file with the format yapion, For more information see YAPIONParser or YAPIONInputStream.
static java.lang.String	FILE_ENDING_POINT	This is the default file ending associated by a file with the format yapion, For more information see YAPIONParser or YAPIONInputStream.

Method Summary

Modifier and Type	Method	Description
static YAPIONObject	flatten(YAPIONObject yapionObject)	The inputted YAPIONObject is flattened to one YAPIONObject as the main layer.
static YAPIONUtils.CheckResult	isBase64YAPIONObject(java.lang.String base64)	Check if a base64 encoded String can be a YAPION Object serialized by the YAPIONSerializer that can be deserialized by the YAPIONDeserializer.
static YAPIONUtils.CheckResult	isStringYAPIONObject(java.lang.String string)	Check if a generic String can be a YAPION Object serialized by the YAPIONSerializer that can be deserialized by the YAPIONDeserializer.
static YAPIONUtils.CheckResult	stringContainsYAPIONObject(java.lang.String string)	Check if a generic String has YAPIONObjects embedded which can be deserialized by the YAPIONDeserializer.
static java.util.List<YAPIONObject>	stringGetAllYAPIONObjects(java.lang.String string)	Retrieve any YAPIONObject embedded in an generic String.
static YAPIONObject	unflatten(YAPIONObject yapionObject)
static java.util.stream.Stream<YAPIONAnyType>	walk(YAPIONObject yapionObject)	The inputted YAPIONObject is traversed depth first, values beforehand.
static <T extends YAPIONAnyType> java.util.stream.Stream<T>	walk(YAPIONObject yapionObject, java.lang.Class<T> classToWalk)	The inputted YAPIONObject is traversed depth first, values beforehand.
static java.util.stream.Stream<YAPIONAnyType>	walk(YAPIONObject yapionObject, YAPIONTreeIterator.YAPIONTreeIteratorOption option)	The inputted YAPIONObject is traversed depth first, values beforehand.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_ENDING

public static final java.lang.String FILE_ENDING

This is the default file ending associated by a file with the format yapion, For more information see YAPIONParser or YAPIONInputStream.

See Also:

Constant Field Values

FILE_ENDING_POINT

public static final java.lang.String FILE_ENDING_POINT

This is the default file ending associated by a file with the format yapion, For more information see YAPIONParser or YAPIONInputStream.

See Also:

Constant Field Values

Method Detail

isBase64YAPIONObject

public static YAPIONUtils.CheckResult isBase64YAPIONObject(java.lang.String base64)

Check if a base64 encoded String can be a YAPION Object serialized by the YAPIONSerializer that can be deserialized by the YAPIONDeserializer.

Parameters:

base64 - the base64 string to check

Returns:

the estimate if the string is yapion or not

isStringYAPIONObject

public static YAPIONUtils.CheckResult isStringYAPIONObject(java.lang.String string)

Check if a generic String can be a YAPION Object serialized by the YAPIONSerializer that can be deserialized by the YAPIONDeserializer.

Parameters:

string - the string to check

Returns:

the estimate if the string is yapion or not

stringContainsYAPIONObject

public static YAPIONUtils.CheckResult stringContainsYAPIONObject(java.lang.String string)

Check if a generic String has YAPIONObjects embedded which can be deserialized by the YAPIONDeserializer.

Parameters:

string - the string to check

Returns:

the result if the String contains an YAPIONObject

stringGetAllYAPIONObjects

public static java.util.List<YAPIONObject> stringGetAllYAPIONObjects(java.lang.String string)

Retrieve any YAPIONObject embedded in an generic String.

Parameters:

string - the string to extract from

Returns:

all YAPIONObject's that got extracted

walk

public static java.util.stream.Stream<YAPIONAnyType> walk(YAPIONObject yapionObject,
                                                          YAPIONTreeIterator.YAPIONTreeIteratorOption option)

The inputted YAPIONObject is traversed depth first, values beforehand. Outputs an Stream of YAPIONAnyType of all keys in the whole YAPIONObject. This method is inspired by Files.walk(Path, FileVisitOption...)

Parameters:

yapionObject - the YAPIONObject to traverse

option - the YAPIONTreeIterator.YAPIONTreeIteratorOption to use

Returns:

the Stream which contains all YAPIONAnyType of the YAPIONObject

walk

public static <T extends YAPIONAnyType> java.util.stream.Stream<T> walk(YAPIONObject yapionObject,
                                                                        java.lang.Class<T> classToWalk)

The inputted YAPIONObject is traversed depth first, values beforehand. Outputs an Stream of YAPIONAnyType of all keys in the whole YAPIONObject. This method is inspired by Files.walk(Path, FileVisitOption...)

Type Parameters:

T - the type to walk

Parameters:

yapionObject - to traverse

classToWalk - the class of given type

Returns:

the Stream which contains all 'T' of the YAPIONObject

walk

public static java.util.stream.Stream<YAPIONAnyType> walk(YAPIONObject yapionObject)

The inputted YAPIONObject is traversed depth first, values beforehand. Outputs an Stream of YAPIONAnyType of all keys in the whole YAPIONObject. This method is inspired by Files.walk(Path, FileVisitOption...)

Parameters:

yapionObject - the YAPIONObject to traverse

Returns:

the Stream which contains all YAPIONAnyType of the YAPIONObject

flatten

public static YAPIONObject flatten(YAPIONObject yapionObject)

The inputted YAPIONObject is flattened to one YAPIONObject as the main layer. Every value will be put under this and every structure will be removed. This will also remove any information about maps arrays and such.

(@pointer:...) will represent a pointer

Parameters:

yapionObject - the YAPIONObject to flatten

Returns:

the flattened YAPIONObject this is a new instance

unflatten

public static YAPIONObject unflatten(YAPIONObject yapionObject)