org.jboss.shrinkwrap.descriptor.api.permissions7

Interface PermissionsDescriptor

All Superinterfaces:

Descriptor, DescriptorNamespace<PermissionsDescriptor>, PermissionsCommonDescriptor<PermissionsDescriptor>

public interface PermissionsDescriptor
extends Descriptor, DescriptorNamespace<PermissionsDescriptor>, PermissionsCommonDescriptor<PermissionsDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

PermissionsDescriptor descriptor = Descriptors.create(PermissionsDescriptor.class);

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Method Summary

Modifier and Type	Method and Description
Permission<PermissionsDescriptor>	createPermission() Creates a new permission element
List<Permission<PermissionsDescriptor>>	getAllPermission() Returns all permission elements
Permission<PermissionsDescriptor>	getOrCreatePermission() If not already created, a new permission element will be created and returned.
String	getVersion() Returns the version attribute
PermissionsDescriptor	removeAllPermission() Removes all permission elements
PermissionsDescriptor	removeVersion() Removes the version attribute
PermissionsDescriptor	version(String version) Sets the version attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

exportAsString, exportTo, getDescriptorName

Field Detail

VERSION

static final String VERSION

See Also:

Constant Field Values

Method Detail

getOrCreatePermission

Permission<PermissionsDescriptor> getOrCreatePermission()

If not already created, a new permission element will be created and returned. Otherwise, the first existing permission element will be returned.

Returns:

the instance defined for the element permission

createPermission

Permission<PermissionsDescriptor> createPermission()

Creates a new permission element

Returns:

the new created instance of Permission

getAllPermission

List<Permission<PermissionsDescriptor>> getAllPermission()

Returns all permission elements

Returns:

list of permission

removeAllPermission

PermissionsDescriptor removeAllPermission()

Removes all permission elements

Returns:

the current instance of Permission

version

PermissionsDescriptor version(String version)

Sets the version attribute

Specified by:

version in interface PermissionsCommonDescriptor<PermissionsDescriptor>

Parameters:

version - the value for the attribute version

Returns:

the current instance of PermissionsDescriptor

getVersion

String getVersion()

Returns the version attribute

Specified by:

getVersion in interface PermissionsCommonDescriptor<PermissionsDescriptor>

Returns:

the value defined for the attribute version

removeVersion

PermissionsDescriptor removeVersion()

Removes the version attribute

Specified by:

removeVersion in interface PermissionsCommonDescriptor<PermissionsDescriptor>

Returns:

the current instance of PermissionsDescriptor