Module org.opendaylight.yangtools.yang.common

Package org.opendaylight.yangtools.yang.common

Class AbstractCanonicalValueValidator<T extends DerivedString<T>,V extends T>

java.lang.Object

org.opendaylight.yangtools.yang.common.AbstractCanonicalValueValidator<T,V>

Type Parameters:

T - string representation class

V - validated string representation class

All Implemented Interfaces:

Immutable, CanonicalValueValidator<T,V>

@Beta
@NonNullByDefault
public abstract class AbstractCanonicalValueValidator<T extends DerivedString<T>,V extends T>
extends Object
implements CanonicalValueValidator<T,V>

Abstract base class for implementing validators.

Author:

Robert Varga

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCanonicalValueValidator(CanonicalValueSupport<T> representationSupport, Class<V> validatedClass)

Method Summary

Modifier and Type	Method	Description
final Class<T>	getRepresentationClass()	Returns the instantiated representation class.
final Class<V>	getValidatedRepresentationClass()	Return the class which captures the fact it was validated by this validator.
protected Either<T,CanonicalValueViolation>	validate(T value)	Validate a DerivedString representation.
protected abstract Either<T,CanonicalValueViolation>	validate(T value, String canonicalString)	Validate a DerivedString representation.
final Either<T,CanonicalValueViolation>	validateRepresentation(T value)	Validate a CanonicalValue representation.
final Either<T,CanonicalValueViolation>	validateRepresentation(T value, String canonicalString)	Validate a CanonicalValue representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractCanonicalValueValidator

protected AbstractCanonicalValueValidator(CanonicalValueSupport<T> representationSupport,
 Class<V> validatedClass)

Method Details

getRepresentationClass

public final Class<T> getRepresentationClass()

Description copied from interface: CanonicalValueValidator

Returns the instantiated representation class. The representation class is a CanonicalValue which understands the semantics of modeled data and has some internal representation of it. All CanonicalValues which share the same representation class are considered equal if their internal state would result in the same canonical string representation as defined by the YANG data model.

Specified by:

getRepresentationClass in interface CanonicalValueValidator<T extends DerivedString<T>,V extends T>

Returns:

Representation CanonicalValue class.

getValidatedRepresentationClass

public final Class<V> getValidatedRepresentationClass()

Description copied from interface: CanonicalValueValidator

Return the class which captures the fact it was validated by this validator.

Specified by:

getValidatedRepresentationClass in interface CanonicalValueValidator<T extends DerivedString<T>,V extends T>

Returns:

Validated capture of the representation class.

validateRepresentation

public final Either<T,CanonicalValueViolation> validateRepresentation(T value)

Description copied from interface: CanonicalValueValidator

Validate a CanonicalValue representation. Implementations should override this method if they can provide a validation algorithm which does not rely on canonical strings but works on representation state only.

Specified by:

validateRepresentation in interface CanonicalValueValidator<T extends DerivedString<T>,V extends T>

Parameters:

value - Representation value

Returns:

Validated representation or a CanonicalValueViolation

validateRepresentation

public final Either<T,CanonicalValueViolation> validateRepresentation(T value,
 String canonicalString)

Description copied from interface: CanonicalValueValidator

Validate a CanonicalValue representation. Implementations can chose whether they operate on representation state or canonical string -- both are considered equivalent. Users should call this method if they have a representation readily available.

Specified by:

validateRepresentation in interface CanonicalValueValidator<T extends DerivedString<T>,V extends T>

Parameters:

value - Representation value

canonicalString - Canonical string matching the representation value

Returns:

Validated representation or a CanonicalValueViolation

validate

protected Either<T,CanonicalValueViolation> validate(T value)

Validate a DerivedString representation. Subclasses should override this method if they can provide a validation algorithm which does not rely on canonical strings but works on representation state only.

Parameters:

value - Representation value

Returns:

Validated representation or CanonicalValueViolation

Throws:

NullPointerException - if value is null

validate

protected abstract Either<T,CanonicalValueViolation> validate(T value,
 String canonicalString)

Validate a DerivedString representation. Subclasses can chose whether they operate on representation state or canonical string -- both are considered equivalent.

Parameters:

value - Representation value

canonicalString - Canonical string matching the representation value

Returns:

Validated representation

Throws:

NullPointerException - if value or canonicalString is null.