io.github.fablabsmc.fablabs.api.fiber.v1.schema.type

Class StringSerializableType

java.lang.Object

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.SerializableType<T>

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.PlainSerializableType<String>

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.StringSerializableType

public final class StringSerializableType
extends PlainSerializableType<String>

The SerializableType for regex-defined String values.

Field Summary

Fields

Modifier and Type	Field and Description
static StringSerializableType	DEFAULT_STRING

Constructor Summary

Constructors

Constructor and Description
StringSerializableType(int minLength, int maxLength, Pattern pattern)

Method Summary

Modifier and Type	Method and Description
<S> String	deserializeValue(S elem, ValueSerializer<S,?> serializer) Deserializes a config primitive from a serialized form.
boolean	equals(Object o) Two serialized types are equal if and only if they are of the same kind and both have the same constraints.
int	getMaxLength() Specifies a maximum string length.
int	getMinLength() Specifies a minimum string length.
Pattern	getPattern() Specifies a pattern that must match.
int	hashCode()
<S> void	serialize(TypeSerializer<S> serializer, S target) Serializes this type to a persistent format using the given TypeSerializer.
<S> S	serializeValue(String value, ValueSerializer<S,?> serializer) Serializes a config primitive to a serialized form.
String	toString()

Methods inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.PlainSerializableType

cast, getErasedPlatformType, getGenericPlatformType

Methods inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.SerializableType

accepts, isAssignableFrom, test

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STRING

public static final StringSerializableType DEFAULT_STRING

Constructor Detail

StringSerializableType

public StringSerializableType(int minLength,
                              int maxLength,
                              @Nullable
                              Pattern pattern)

Method Detail

getMinLength

public int getMinLength()

Specifies a minimum string length.

Values must be of equal or longer length than the returned value to satisfy the constraint. For example: if the min length is 3.

• "AB" would not satisfy the constraint
• "ABC" and "ABCD" would satisfy the constraint

getMaxLength

public int getMaxLength()

Specifies a maximum string length.

Values must be of equal or shorter length than the returned value to satisfy the constraint. For example: if the max length is 3.

• "AB" and "ABC" would satisfy the constraint
• "ABCD" would not satisfy the constraint

getPattern

@Nullable
public Pattern getPattern()

Specifies a pattern that must match.

Values must match the constraint's value, which is a regular expression (regex).

serialize

public <S> void serialize(TypeSerializer<S> serializer,
                          S target)

Description copied from class: SerializableType

Serializes this type to a persistent format using the given TypeSerializer.

Specified by:

serialize in class SerializableType<String>

Type Parameters:

S - The type to serialize to.

Parameters:

serializer - The type serializer to use.

target - The place to which this type is serialized.

See Also:

TypeSerializer

serializeValue

public <S> S serializeValue(String value,
                            ValueSerializer<S,?> serializer)

Description copied from class: SerializableType

Serializes a config primitive to a serialized form. The value given must be compatible with the platform type as given by SerializableType.cast(Object) and additionally satisfy this type's particular constraints.

Specified by:

serializeValue in class SerializableType<String>

Type Parameters:

S - The type of the serialized form.

Parameters:

value - The value to serialize.

serializer - A ValueSerializer defining the serialized form.

Returns:

The serialized form of value.

deserializeValue

public <S> String deserializeValue(S elem,
                                   ValueSerializer<S,?> serializer)
                            throws ValueDeserializationException

Description copied from class: SerializableType

Deserializes a config primitive from a serialized form.

Specified by:

deserializeValue in class SerializableType<String>

Type Parameters:

S - The type of the serialized form.

Parameters:

elem - The serialized form of the value.

serializer - A ValueSerializer defining the serialized form.

Returns:

The deserialized value.

Throws:

ValueDeserializationException - If a value cannot be deserialized.

equals

public boolean equals(Object o)

Description copied from class: SerializableType

Two serialized types are equal if and only if they are of the same kind and both have the same constraints.

Specified by:

equals in class SerializableType<String>

hashCode

public int hashCode()

Specified by:

hashCode in class SerializableType<String>

toString

public String toString()

Specified by:

toString in class SerializableType<String>