Enum ESMPTransportProfile

java.lang.Object
java.lang.Enum<ESMPTransportProfile>
com.helger.peppol.smp.ESMPTransportProfile
All Implemented Interfaces:
com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasName, com.helger.commons.type.IHasObjectType, com.helger.commons.type.ITypedObject<String>, ISMPTransportProfile, Serializable, Comparable<ESMPTransportProfile>, java.lang.constant.Constable

public enum ESMPTransportProfile extends Enum<ESMPTransportProfile> implements ISMPTransportProfile
This class contains predefined transport profiles for service registrations. A generic implementation of ISMPTransportProfile can be found in class SMPTransportProfile.
Author:
Philip Helger
  • Enum Constant Details

  • Method Details

    • values

      public static ESMPTransportProfile[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static ESMPTransportProfile valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getObjectType

      @Nonnull public com.helger.commons.type.ObjectType getObjectType()
      Specified by:
      getObjectType in interface com.helger.commons.type.IHasObjectType
    • getID

      @Nonnull @Nonempty public String getID()
      Description copied from interface: ISMPTransportProfile
      Get the ID to be stored in an SMP endpoint.
      Specified by:
      getID in interface com.helger.commons.id.IHasID<String>
      Specified by:
      getID in interface ISMPTransportProfile
    • getName

      @Nonnull @Nonempty public String getName()
      Description copied from interface: ISMPTransportProfile
      The display name of this transport profile has no semantics and is just for informational purposes. May neither be null nor empty.
      Specified by:
      getName in interface com.helger.commons.name.IHasName
      Specified by:
      getName in interface ISMPTransportProfile
    • getState

      Specified by:
      getState in interface ISMPTransportProfile
      Returns:
      The state of the transport profile. May not be null.
    • getFromIDOrNull

      @Nullable public static ESMPTransportProfile getFromIDOrNull(@Nullable String sID)
      Find the pre-defined transport profile with the passed ID.
      Parameters:
      sID - The ID to be searched. May be null.
      Returns:
      null if no such transport profile was found.