com.helger.peppol.validation.api

Class ValidationKey

java.lang.Object

com.helger.peppol.validation.api.ValidationKey

All Implemented Interfaces:

Serializable, Comparable<ValidationKey>

@Immutable
 @MustImplementEqualsAndHashcode
public class ValidationKey
extends Object
implements Serializable, Comparable<ValidationKey>

An immutable pair of a business specification of type IBusinessSpecification and a transaction of type ISpecificationTransaction.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationKey.Builder Builder class for ValidationKey objects.

Constructor Summary

Constructors

Constructor and Description
ValidationKey(IBusinessSpecification aBusinessSpecification, ISpecificationTransaction aTransaction, String sCountryCode, ValidationSectorKey aSectorKey, String sPrerequisiteXPath)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ValidationKey aOther)
boolean	equals(Object o)
IBusinessSpecification	getBusinessSpecification()
String	getCountryCode()
Locale	getCountryLocale()
Class<?>	getImplementationClass()
String	getPrerequisiteXPath()
ValidationSectorKey	getSectorKey()
ISpecificationTransaction	getTransaction()
int	hashCode()
boolean	hasPrerequisiteXPath()
boolean	hasSameSpecificationAndTransaction(ValidationKey aOther)
boolean	hasSameSpecificationAndTransactionAndCountryAndSector(ValidationKey aOther)
boolean	isCountrySpecific()
boolean	isSectorSpecific()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ValidationKey

public ValidationKey(@Nonnull
                     IBusinessSpecification aBusinessSpecification,
                     @Nonnull
                     ISpecificationTransaction aTransaction,
                     @Nullable
                     String sCountryCode,
                     @Nullable
                     ValidationSectorKey aSectorKey,
                     @Nullable
                     String sPrerequisiteXPath)

Method Detail

getBusinessSpecification

@Nonnull
public IBusinessSpecification getBusinessSpecification()

Returns:

The business specification this validation key refers to. This is the object passed in the constructor. Never null.

getTransaction

@Nonnull
public ISpecificationTransaction getTransaction()

Returns:

The transaction of the specification as passed in the constructor. Never null.

getImplementationClass

@Nonnull
public Class<?> getImplementationClass()

Returns:

The JAXB class implementing the document type referenced by the transaction.

isCountrySpecific

public boolean isCountrySpecific()

Returns:

true if this validation key is country specific, false otherwise.

getCountryLocale

@Nullable
public Locale getCountryLocale()

Returns:

The country locale as specified in the constructor.

getCountryCode

@Nullable
public String getCountryCode()

Returns:

The country code extracted from the contained locale. Never null.

isSectorSpecific

public boolean isSectorSpecific()

Returns:

true if sector specific is enabled, false if not.

getSectorKey

@Nullable
public ValidationSectorKey getSectorKey()

Returns:

The validation sector key specified in the constructor. May be null if not sector specific.

hasPrerequisiteXPath

public boolean hasPrerequisiteXPath()

Returns:

true if a prerequisite XPath expression is present, false if not

getPrerequisiteXPath

@Nullable
public String getPrerequisiteXPath()

Returns:

An optional prerequisite XPath expression that must match before the validation artefact can be applied. May be null.

hasSameSpecificationAndTransaction

public boolean hasSameSpecificationAndTransaction(@Nullable
                                                  ValidationKey aOther)

hasSameSpecificationAndTransactionAndCountryAndSector

public boolean hasSameSpecificationAndTransactionAndCountryAndSector(@Nullable
                                                                     ValidationKey aOther)

compareTo

public int compareTo(@Nonnull
                     ValidationKey aOther)

Specified by:

compareTo in interface Comparable<ValidationKey>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object