org.opendaylight.yangtools.yang.model.api.meta

Class DefaultStatementDefinition<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

java.lang.Object

org.opendaylight.yangtools.yang.model.api.meta.DefaultStatementDefinition<A,D,E>

Type Parameters:

A - Argument type

D - Declared statement representation

E - Effective statement representation

All Implemented Interfaces:

Immutable, MutationBehaviour<Immutable>, StatementDefinition

@Beta
 @NonNullByDefault
 @ThreadSafe
public final class DefaultStatementDefinition<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>
extends Object
implements StatementDefinition

Default implementation of the StatementDefinition contract. Instances of this class should be used as well-known singletons.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
@Nullable QName	getArgumentName() Returns name of statement argument or null, if statement does not have argument.
Class<? extends DeclaredStatement<?>>	getDeclaredRepresentationClass() Returns class which represents declared version of statement associated with this definition.
Class<? extends EffectiveStatement<?,?>>	getEffectiveRepresentationClass() Returns class which represents derived behaviour from supplied statement.
QName	getStatementName() Returns name of the statement.
boolean	isArgumentYinElement() Returns true, if argument of statement is represented as value of yin element.
static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E>	of(QName statementName, Class<D> declaredRepresentation, Class<E> effectiveRepresentation)
static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E>	of(QName statementName, Class<D> declaredRepresentation, Class<E> effectiveRepresentation, QName argumentName)
static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E>	of(QName statementName, Class<D> declaredRepresentation, Class<E> effectiveRepresentation, QName argumentName, boolean argumentYinElement)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E> of(QName statementName,
                                                                                                                        Class<D> declaredRepresentation,
                                                                                                                        Class<E> effectiveRepresentation)

of

public static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E> of(QName statementName,
                                                                                                                        Class<D> declaredRepresentation,
                                                                                                                        Class<E> effectiveRepresentation,
                                                                                                                        QName argumentName)

of

public static <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>> DefaultStatementDefinition<A,D,E> of(QName statementName,
                                                                                                                        Class<D> declaredRepresentation,
                                                                                                                        Class<E> effectiveRepresentation,
                                                                                                                        QName argumentName,
                                                                                                                        boolean argumentYinElement)

getStatementName

public QName getStatementName()

Description copied from interface: StatementDefinition

Returns name of the statement.

Specified by:

getStatementName in interface StatementDefinition

Returns:

Name of the statement

getArgumentName

public @Nullable QName getArgumentName()

Description copied from interface: StatementDefinition

Returns name of statement argument or null, if statement does not have argument.

Specified by:

getArgumentName in interface StatementDefinition

Returns:

argument name or null, if statement does not take argument.

getDeclaredRepresentationClass

public Class<? extends DeclaredStatement<?>> getDeclaredRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents declared version of statement associated with this definition. This class should be an interface which provides convenience access to declared substatements.

Specified by:

getDeclaredRepresentationClass in interface StatementDefinition

Returns:

class which represents declared version of statement associated with this definition.

getEffectiveRepresentationClass

public Class<? extends EffectiveStatement<?,?>> getEffectiveRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents derived behaviour from supplied statement. This class should be an interface which defines convenience access to statement properties, namespace items and substatements.

Specified by:

getEffectiveRepresentationClass in interface StatementDefinition

Returns:

class which represents effective version of statement associated with this definition

isArgumentYinElement

public boolean isArgumentYinElement()

Description copied from interface: StatementDefinition

Returns true, if argument of statement is represented as value of yin element. If argument of statement is represented as argument of yin element, returns false. If this statement does not have an argument, this method returns false.

Specified by:

isArgumentYinElement in interface StatementDefinition

Returns:

returns true, if statement argument is represented as value of yin element, otherwise returns false.

toString

public String toString()

Overrides:

toString in class Object