Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.copy.field.into.field._case

Interface FlowModCopyFieldIntoField

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<FlowModCopyFieldIntoField>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<FlowModSpec>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

@Generated("mdsal-binding-generator")
public interface FlowModCopyFieldIntoField
extends org.opendaylight.yangtools.yang.binding.ChildOf<FlowModSpec>, org.opendaylight.yangtools.yang.binding.Augmentable<FlowModCopyFieldIntoField>

This class represents the following YANG schema fragment defined in module nicira-action

 container flow-mod-copy-field-into-field {
   leaf flow-mod-num-bits {
     type uint16;
   }
   leaf src-field {
     type uint32;
   }
   leaf src-ofs {
     type uint16;
   }
   leaf dst-field {
     type uint32;
   }
   leaf dst-ofs {
     type uint16;
   }
 }
 

To create instances of this class use FlowModCopyFieldIntoFieldBuilder.

See Also:

• FlowModCopyFieldIntoFieldBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME	YANG identifier of the statement represented by this class.

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull FlowModCopyFieldIntoField thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull FlowModCopyFieldIntoField obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull FlowModCopyFieldIntoField obj)	Default implementation of Object.toString() contract for this interface.
org.opendaylight.yangtools.yang.common.Uint32	getDstField()	Return dstField, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint16	getDstOfs()	Return dstOfs, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint16	getFlowModNumBits()	Return flowModNumBits, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getSrcField()	Return srcField, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint16	getSrcOfs()	Return srcOfs, or null if it is not present.
default Class<FlowModCopyFieldIntoField>	implementedInterface()
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireDstField()	Return dstField, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint16	requireDstOfs()	Return dstOfs, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint16	requireFlowModNumBits()	Return flowModNumBits, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireSrcField()	Return srcField, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint16	requireSrcOfs()	Return srcOfs, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

Field Details

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

YANG identifier of the statement represented by this class.

Method Details

implementedInterface

default Class<FlowModCopyFieldIntoField> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

bindingHashCode

static int bindingHashCode(@NonNull FlowModCopyFieldIntoField obj)

Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.

Parameters:

obj - Object for which to generate hashCode() result.

Returns:

Hash code value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

bindingEquals

static boolean bindingEquals(@NonNull FlowModCopyFieldIntoField thisObj,
 Object obj)

Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.

Parameters:

thisObj - Object acting as the receiver of equals invocation

obj - Object acting as argument to equals invocation

Returns:

True if thisObj and obj are considered equal

Throws:

NullPointerException - if thisObj is null

bindingToString

static String bindingToString(@NonNull FlowModCopyFieldIntoField obj)

Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.

Parameters:

obj - Object for which to generate toString() result.

Returns:

String value of data modeled by this interface.

Throws:

NullPointerException - if obj is null

getFlowModNumBits

org.opendaylight.yangtools.yang.common.Uint16 getFlowModNumBits()

Return flowModNumBits, or null if it is not present.

Returns:

Uint16 flowModNumBits, or null if it is not present.

requireFlowModNumBits

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireFlowModNumBits()

Return flowModNumBits, guaranteed to be non-null.

Returns:

Uint16 flowModNumBits, guaranteed to be non-null.

Throws:

NoSuchElementException - if flowModNumBits is not present

getSrcField

org.opendaylight.yangtools.yang.common.Uint32 getSrcField()

Return srcField, or null if it is not present.

Returns:

Uint32 srcField, or null if it is not present.

requireSrcField

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSrcField()

Return srcField, guaranteed to be non-null.

Returns:

Uint32 srcField, guaranteed to be non-null.

Throws:

NoSuchElementException - if srcField is not present

getSrcOfs

org.opendaylight.yangtools.yang.common.Uint16 getSrcOfs()

Return srcOfs, or null if it is not present.

Returns:

Uint16 srcOfs, or null if it is not present.

requireSrcOfs

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireSrcOfs()

Return srcOfs, guaranteed to be non-null.

Returns:

Uint16 srcOfs, guaranteed to be non-null.

Throws:

NoSuchElementException - if srcOfs is not present

getDstField

org.opendaylight.yangtools.yang.common.Uint32 getDstField()

Return dstField, or null if it is not present.

Returns:

Uint32 dstField, or null if it is not present.

requireDstField

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDstField()

Return dstField, guaranteed to be non-null.

Returns:

Uint32 dstField, guaranteed to be non-null.

Throws:

NoSuchElementException - if dstField is not present

getDstOfs

org.opendaylight.yangtools.yang.common.Uint16 getDstOfs()

Return dstOfs, or null if it is not present.

Returns:

Uint16 dstOfs, or null if it is not present.

requireDstOfs

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireDstOfs()

Return dstOfs, guaranteed to be non-null.

Returns:

Uint16 dstOfs, guaranteed to be non-null.

Throws:

NoSuchElementException - if dstOfs is not present