com.helger.peppol.validation.api.peppol

Enum EBII2Profile

java.lang.Object

java.lang.Enum<EBII2Profile>

com.helger.peppol.validation.api.peppol.EBII2Profile

All Implemented Interfaces:

com.helger.commons.text.display.IHasDisplayText, ISpecificationProfile, Serializable, Comparable<EBII2Profile>

public enum EBII2Profile
extends Enum<EBII2Profile>
implements ISpecificationProfile

Defines the predefined CEN BII2 profiles. Each profile consists of a set of transactions (EBII2Transaction) and belongs to a group EBII2Group (derived from the transactions).

Author:

PEPPOL.AT, BRZ, Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
BII_MLR
BII01
BII02
BII03
BII04
BII05
BII06
BII10
BII11
BII12
BII16
BII17
BII21
BII22
BII27
BII28
BII30
BII31
BII32
BII33
BII34
BII35

Method Summary

Modifier and Type	Method and Description
boolean	containsTransaction(ISpecificationTransaction aTransaction) Check if the passed transaction is contained in this profile.
static com.helger.commons.collection.ext.ICommonsList<EBII2Profile>	getAllProfilesWithTransaction(EBII2Transaction eTransaction) Get a list with all profiles supporting a certain transaction.
com.helger.commons.collection.ext.ICommonsList<EBII2Transaction>	getAllTransactions()
String	getDisplayText(Locale aContentLocale)
EBII2Group	getGroup()
int	getNumber()
static EBII2Profile	valueOf(String name) Returns the enum constant of this type with the specified name.
static EBII2Profile[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, 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.commons.text.display.IHasDisplayText

getComparatorCollating

Enum Constant Detail

BII_MLR

public static final EBII2Profile BII_MLR

BII01

public static final EBII2Profile BII01

BII02

public static final EBII2Profile BII02

BII03

public static final EBII2Profile BII03

BII04

public static final EBII2Profile BII04

BII05

public static final EBII2Profile BII05

BII06

public static final EBII2Profile BII06

BII10

public static final EBII2Profile BII10

BII11

public static final EBII2Profile BII11

BII12

public static final EBII2Profile BII12

BII16

public static final EBII2Profile BII16

BII17

public static final EBII2Profile BII17

BII21

public static final EBII2Profile BII21

BII22

public static final EBII2Profile BII22

BII27

public static final EBII2Profile BII27

BII28

public static final EBII2Profile BII28

BII30

public static final EBII2Profile BII30

BII31

public static final EBII2Profile BII31

BII32

public static final EBII2Profile BII32

BII33

public static final EBII2Profile BII33

BII34

public static final EBII2Profile BII34

BII35

public static final EBII2Profile BII35

Method Detail

values

public static EBII2Profile[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EBII2Profile c : EBII2Profile.values())
    System.out.println(c);

Returns:

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

valueOf

public static EBII2Profile 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

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aContentLocale)

Specified by:

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

Returns:

The display name of this profile in the specified locale. Currently only English is supported.

getNumber

@Nonnegative
public int getNumber()

Specified by:

getNumber in interface ISpecificationProfile

Returns:

The numeric value of this profile (e.g. BII04 returns 4, BII22 returns 22 etc.). Some special profiles (like BII2 MLR) return 0!

getGroup

@Nonnull
public EBII2Group getGroup()

Specified by:

getGroup in interface ISpecificationProfile

Returns:

The group to which all transaction belong. Never null.

getAllTransactions

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<EBII2Transaction> getAllTransactions()

Specified by:

getAllTransactions in interface ISpecificationProfile

Returns:

A non-null non empty list of all transactions contained in this profile.

containsTransaction

public boolean containsTransaction(@Nullable
                                   ISpecificationTransaction aTransaction)

Description copied from interface: ISpecificationProfile

Check if the passed transaction is contained in this profile.

Specified by:

containsTransaction in interface ISpecificationProfile

Parameters:

aTransaction - The transaction to query. May be null.

Returns:

true if the passed transaction is contained in this profile, false otherwise.

getAllProfilesWithTransaction

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.ext.ICommonsList<EBII2Profile> getAllProfilesWithTransaction(@Nonnull
                                                                                                                                         EBII2Transaction eTransaction)

Get a list with all profiles supporting a certain transaction.

Parameters:

eTransaction - The transaction to be searched. May not be null.

Returns:

A non-null non-empty list with all transactions. It may never be empty, because each transaction must occur in at least one transaction.