Package dev.orne.beans

Class StringIdentity

java.lang.Object
dev.orne.beans.AbstractIdentity
dev.orne.beans.AbstractSimpleIdentity<String>
dev.orne.beans.StringIdentity
All Implemented Interfaces:
Identity, Serializable
@API(status=STABLE, since="0.1") public class StringIdentity extends AbstractSimpleIdentity<String>
Implementation for Identity for identities composed of a single inner String value.
Since:
0.1
Version:
1.0, 2020-05
Author:
(w) Iker Hernaez
See Also:

  • Constructor Details

    • StringIdentity

      @GeneratorMethod public StringIdentity(String value)
      Creates a new instance.
      Parameters:
      value - The identity value

    • StringIdentity

      public StringIdentity(@NotNull @NotNull StringIdentity copy)
      Copy constructor.
      Parameters:
      copy - The instance to copy

  • Method Details

    • fromIdentityToken

      @IdentityTokenResolver @NotNull public static @NotNull StringIdentity fromIdentityToken(@NotNull @NotNull String token)
      Resolves the specified identity token to a valid StringIdentity.
      Parameters:
      token - The identity token
      Returns:
      The resolved identity token
      Throws:
      NullPointerException - If the identity token is null
      UnrecognizedIdentityTokenException - If the identity token is not a valid identity token or it doesn't start with the expected prefix

    • extractTokenValue

      public static String extractTokenValue(@NotNull @NotNull String prefix, @NotNull @NotNull String token)
      Extracts the String value of a token generated by StringIdentity.

      Note that the resulting value can be null. If a non-null value is expected useextractRequiredTokenValue(String, String).

      Parameters:
      prefix - The expected identity token prefix.
      token - The identity token.
      Returns:
      The extracted String value.
      Throws:
      NullPointerException - If the identity token is null
      UnrecognizedIdentityTokenException - If the identity token is not a valid simple identity token or if it doesn't start with the expected prefix.
      See Also:

    • extractRequiredTokenValue

      @NotNull public static @NotNull String extractRequiredTokenValue(@NotNull @NotNull String prefix, @NotNull @NotNull String token)
      Extracts the String value of a token generated by StringIdentity.

      If the resulting value is null an exception is thrown.

      Parameters:
      prefix - The expected identity token prefix.
      token - The identity token.
      Returns:
      The extracted String value.
      Throws:
      NullPointerException - If the identity token is null
      UnrecognizedIdentityTokenException - If the identity token is not a valid simple identity token, if it doesn't start with the expected prefix or if the extracted value is null.
      See Also: