Package org.dmfs.httpessentials.typedentity

Interface EntityType<ValueType>

Type Parameters:
ValueType - The type of the entity value.
All Known Subinterfaces:
HeaderType<ValueType>, ListHeaderType<ValueType>, ParameterType<ValueType>, SingletonHeaderType<ValueType>
public interface EntityType<ValueType>
Represents type of an Entity. That is, it binds a type name to a value type.

  • Method Details

    • name

      String name()
      Returns the name of the type.
      Returns:
      The type name, never null.

    • entityFromString

      Entity<ValueType> entityFromString(String valueString)
      Factory method to create Entitys of this type from the given String representation.
      Parameters:
      valueString - The String representation of the entity value.
      Returns:
      A new Entity instance.

    • valueFromString

      ValueType valueFromString(String valueString)
      Convert a string to a value of type <ValueType>
      Parameters:
      valueString - The String representation of the entity value.
      Returns:
      A new entity value.

    • entity

      Entity<ValueType> entity(ValueType value)
      Factory method to create Entitys of this EntityType from a value.
      Parameters:
      value - The entity value, must not be null
      Returns:
      A new Entity instance.

    • valueString

      String valueString(ValueType value)
      Returns the string representation of the given entity value as defined for this EntityType.
      Parameters:
      value - The value to convert.
      Returns:
      A value String representing the given value.