org.dmd.dmu.server.generated.dmw

Class PayloadSortInfoDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dmu.server.generated.dmw.DmuDefinitionDMW

org.dmd.dmu.server.extended.DmuDefinition

org.dmd.dmu.server.generated.dmw.PayloadSortInfoDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

PayloadSortInfo

public abstract class PayloadSortInfoDMW
extends DmuDefinition
implements DmcDefinitionIF, DmcNamedObjectIF

json: In order to perform the diff between an existing configuration on\n the device and an incoming payload, the JSON objects must have arrays of objects\n sorted based on specified key values. Otherwise, the com.github.fge.jsonpatch.diff.JsonDiff\n diff mechanisms can't provide a decent comparison.

Generated from the dmu schema at version unknown

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	PayloadSortInfoDMW()
	PayloadSortInfoDMW(DmcTypeModifierMV mods)
	PayloadSortInfoDMW(PayloadSortInfoDMO obj)
protected	PayloadSortInfoDMW(PayloadSortInfoDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addPathAndKeys(Object value) Adds another pathAndKeys value.
void	addPathAndKeys(PathAndKey value) Adds another pathAndKeys value.
PayloadSortInfo	cloneIt()
void	delPathAndKeys(Object value) Deletes a pathAndKeys value.
void	delPathAndKeys(PathAndKey value) Deletes a pathAndKeys value.
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
PayloadSortInfoDMO	getDMO()
PayloadSortInfo	getModificationRecorder()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
String	getNameOfModuleWhereThisCameFrom() This method indicates the name of the module from which this definition was loaded.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
ArrayList<PathAndKey>	getPathAndKeysCopy()
boolean	getPathAndKeysHasValue()
boolean	getPathAndKeysIsEmpty()
PathAndKeyIterableDMW	getPathAndKeysIterable()
int	getPathAndKeysSize()
int	hashCode()
boolean	pathAndKeysContains(PathAndKey value)
void	remName() Removes the name attribute value.
void	remPathAndKeys() Removes the pathAndKeys attribute value.
void	setName(DefinitionName value) Sets name to the specified value.
void	setName(Object value) Sets name to the specified value.

Methods inherited from class org.dmd.dmu.server.extended.DmuDefinition

initialize

Methods inherited from class org.dmd.dmu.server.generated.dmw.DmuDefinitionDMW

getDefinedInDmuModule, remDefinedInDmuModule, setDefinedInDmuModule, setDefinedInDmuModule

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addDescription, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmcObject, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Constructor Detail

PayloadSortInfoDMW

public PayloadSortInfoDMW()

PayloadSortInfoDMW

public PayloadSortInfoDMW(DmcTypeModifierMV mods)

PayloadSortInfoDMW

public PayloadSortInfoDMW(PayloadSortInfoDMO obj)

PayloadSortInfoDMW

protected PayloadSortInfoDMW(PayloadSortInfoDMO obj,
                             ClassDefinition cd)

Method Detail

getModificationRecorder

public PayloadSortInfo getModificationRecorder()

Specified by:

getModificationRecorder in class DmuDefinitionDMW

cloneIt

public PayloadSortInfo cloneIt()

getDMO

public PayloadSortInfoDMO getDMO()

Overrides:

getDMO in class DmuDefinitionDMW

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class DmuDefinitionDMW

Returns:

The name of this object from the name attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class DmuDefinitionDMW

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class DmuDefinitionDMW

Returns:

The name attribute.

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class DmuDefinitionDMW

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getName

public DefinitionName getName()

Description copied from class: DSDefinitionDMW

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class DmuDefinitionDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class DmuDefinitionDMW

Parameters:

value - A value compatible with DmcTypeDefinitionName

Throws:

DmcValueException - if the value is incorrect

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class DmuDefinitionDMW

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class DmuDefinitionDMW

getPathAndKeysSize

public int getPathAndKeysSize()

Returns:

The number of PathAndKey items.

getPathAndKeysIsEmpty

public boolean getPathAndKeysIsEmpty()

Returns:

true if there are no PathAndKeyDMO items.

getPathAndKeysHasValue

public boolean getPathAndKeysHasValue()

Returns:

true if there are any PathAndKeyDMO items.

getPathAndKeysIterable

public PathAndKeyIterableDMW getPathAndKeysIterable()

Returns:

An Iterator of PathAndKey objects.

addPathAndKeys

public void addPathAndKeys(Object value)
                    throws DmcValueException

Adds another pathAndKeys value.

Parameters:

value - A value compatible with PathAndKey

Throws:

DmcValueException - if value is incorrect

addPathAndKeys

public void addPathAndKeys(PathAndKey value)

Adds another pathAndKeys value.

Parameters:

value - A value compatible with PathAndKey

pathAndKeysContains

public boolean pathAndKeysContains(PathAndKey value)

Parameters:

value - A value compatible with PathAndKey

Returns:

true if the collection contains the pathAndKeys value.

getPathAndKeysCopy

public ArrayList<PathAndKey> getPathAndKeysCopy()

Returns:

A COPY of the collection of PathAndKey objects.

delPathAndKeys

public void delPathAndKeys(Object value)
                    throws DmcValueException

Deletes a pathAndKeys value.

Parameters:

value - The PathAndKey to be deleted from set of attribute values.

Throws:

DmcValueException - if value is incorrect

delPathAndKeys

public void delPathAndKeys(PathAndKey value)

Deletes a pathAndKeys value.

Parameters:

value - The PathAndKey to be deleted from set of attribute values.

remPathAndKeys

public void remPathAndKeys()

Removes the pathAndKeys attribute value.

getNameOfModuleWhereThisCameFrom

public String getNameOfModuleWhereThisCameFrom()

This method indicates the name of the module from which this definition was loaded.

Overrides:

getNameOfModuleWhereThisCameFrom in class DSDefinition