Package com.helger.peppol.smp

Enum Class ESMPTransportProfileState

java.lang.Object

java.lang.Enum<ESMPTransportProfileState>

com.helger.peppol.smp.ESMPTransportProfileState

All Implemented Interfaces:

com.helger.base.id.IHasID<String>, com.helger.text.display.IHasDisplayText, Serializable, Comparable<ESMPTransportProfileState>, Constable

public enum ESMPTransportProfileState
extends Enum<ESMPTransportProfileState>
implements com.helger.base.id.IHasID<String>, com.helger.text.display.IHasDisplayText

This enum defines the potential states for SMP transport profiles.

Since:

8.8.3

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	A transport profile with this state can be used without limitation.
DELETED	This transport profile can no longer be used.
DEPRECATED	A transport profile can still be used, but should not be used for new SMP entries.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getDisplayText(@NonNull Locale aContentLocale)
static @Nullable ESMPTransportProfileState	getFromIDOrNull(@Nullable String sID)	Find the pre-defined transport profile state with the passed ID.
@NonNull @Nonempty String	getID()
boolean	isActive()
boolean	isDeleted()
boolean	isDeprecated()
static ESMPTransportProfileState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ESMPTransportProfileState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.text.display.IHasDisplayText

getAsHasText

Enum Constant Details

ACTIVE

public static final ESMPTransportProfileState ACTIVE

A transport profile with this state can be used without limitation.

DEPRECATED

public static final ESMPTransportProfileState DEPRECATED

A transport profile can still be used, but should not be used for new SMP entries.

DELETED

public static final ESMPTransportProfileState DELETED

This transport profile can no longer be used.

Method Details

values

public static ESMPTransportProfileState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ESMPTransportProfileState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getID

@Nonempty
public @NonNull @Nonempty String getID()

Specified by:

getID in interface com.helger.base.id.IHasID<String>

getDisplayText

public @Nullable String getDisplayText(@NonNull Locale aContentLocale)

Specified by:

getDisplayText in interface com.helger.text.display.IHasDisplayText

isActive

public boolean isActive()

isDeprecated

public boolean isDeprecated()

isDeleted

public boolean isDeleted()

getFromIDOrNull

public static @Nullable ESMPTransportProfileState getFromIDOrNull(@Nullable String sID)

Find the pre-defined transport profile state with the passed ID.

Parameters:

sID - The ID to be searched. May be null.

Returns:

null if no such transport profile was found.