Package org.jboss.as.controller

Class OperationDefinition

java.lang.Object

org.jboss.as.controller.OperationDefinition

All Implemented Interfaces:

Feature

Direct Known Subclasses:

SimpleOperationDefinition

public abstract class OperationDefinition
extends Object
implements Feature

Defining characteristics of operation in a Resource

Author:

Tomaz Cerar

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AccessConstraintDefinition>	accessConstraints
protected DeprecationData	deprecationData
protected DescriptionProvider	descriptionProvider
protected OperationEntry.EntryType	entryType
protected Set<OperationEntry.Flag>	flags
protected String	name
protected AttributeDefinition[]	parameters
protected boolean	replyAllowNull
protected AttributeDefinition[]	replyParameters
protected org.jboss.dmr.ModelType	replyType
protected org.jboss.dmr.ModelType	replyValueType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OperationDefinition(SimpleOperationDefinitionBuilder builder)

Method Summary

Modifier and Type	Method	Description
List<AccessConstraintDefinition>	getAccessConstraints()
DeprecationData	getDeprecationData()
abstract DescriptionProvider	getDescriptionProvider()
OperationEntry.EntryType	getEntryType()
Set<OperationEntry.Flag>	getFlags()	Gets an immutable set of any flags associated with the operation.
String	getName()
AttributeDefinition[]	getParameters()
AttributeDefinition[]	getReplyParameters()
org.jboss.dmr.ModelType	getReplyType()
org.jboss.dmr.ModelType	getReplyValueType()	Only required if the reply type is some form of collection.
Stability	getStability()	Returns the stability level of this feature.
boolean	isDeprecated()
boolean	isReplyAllowNull()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

entryType

protected final OperationEntry.EntryType entryType

flags

protected final Set<OperationEntry.Flag> flags

parameters

protected final AttributeDefinition[] parameters

replyType

protected final org.jboss.dmr.ModelType replyType

replyValueType

protected final org.jboss.dmr.ModelType replyValueType

replyAllowNull

protected final boolean replyAllowNull

deprecationData

protected final DeprecationData deprecationData

replyParameters

protected final AttributeDefinition[] replyParameters

accessConstraints

protected final List<AccessConstraintDefinition> accessConstraints

descriptionProvider

protected final DescriptionProvider descriptionProvider

Constructor Detail

OperationDefinition

protected OperationDefinition(SimpleOperationDefinitionBuilder builder)

Method Detail

getStability

public Stability getStability()

Description copied from interface: Feature

Returns the stability level of this feature.

Specified by:

getStability in interface Feature

Returns:

a stability level

getName

public String getName()

getEntryType

public OperationEntry.EntryType getEntryType()

getFlags

public Set<OperationEntry.Flag> getFlags()

Gets an immutable set of any flags associated with the operation.

Returns:

the flags. Will not return null be may be empty

getParameters

public AttributeDefinition[] getParameters()

getReplyType

public org.jboss.dmr.ModelType getReplyType()

getReplyValueType

public org.jboss.dmr.ModelType getReplyValueType()

Only required if the reply type is some form of collection.

getAccessConstraints

public List<AccessConstraintDefinition> getAccessConstraints()

getDescriptionProvider

public abstract DescriptionProvider getDescriptionProvider()

getDeprecationData

public DeprecationData getDeprecationData()

isDeprecated

public boolean isDeprecated()

isReplyAllowNull

public boolean isReplyAllowNull()

getReplyParameters

public AttributeDefinition[] getReplyParameters()