org.jboss.shrinkwrap.descriptor.api.application5.ApplicationDescriptor Maven / Gradle / Ivy
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
package org.jboss.shrinkwrap.descriptor.api.application5;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.application5.ModuleType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.SecurityRoleType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.application.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* ApplicationDescriptor descriptor = Descriptors.create(ApplicationDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface ApplicationDescriptor extends Descriptor, DescriptorNamespace,
ApplicationCommonDescriptor,
SecurityRoleType> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description elements,
* a new description element
* @param values list of description objects
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType
*/
public IconType createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType
*/
public ApplicationDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: javaee:moduleType ElementType : module
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new module element will be created and returned.
* Otherwise, the first existing module element will be returned.
* @return the instance defined for the element module
*/
public ModuleType getOrCreateModule();
/**
* Creates a new module element
* @return the new created instance of ModuleType
*/
public ModuleType createModule();
/**
* Returns all module elements
* @return list of module
*/
public List> getAllModule();
/**
* Removes all module elements
* @return the current instance of ModuleType
*/
public ApplicationDescriptor removeAllModule();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: javaee:security-roleType ElementType : security-role
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new security-role element will be created and returned.
* Otherwise, the first existing security-role element will be returned.
* @return the instance defined for the element security-role
*/
public SecurityRoleType getOrCreateSecurityRole();
/**
* Creates a new security-role element
* @return the new created instance of SecurityRoleType
*/
public SecurityRoleType createSecurityRole();
/**
* Returns all security-role elements
* @return list of security-role
*/
public List> getAllSecurityRole();
/**
* Removes all security-role elements
* @return the current instance of SecurityRoleType
*/
public ApplicationDescriptor removeAllSecurityRole();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: xsd:token ElementType : library-directory
// MaxOccurs: -1 isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the library-directory element
* @param libraryDirectory the value for the element library-directory
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor libraryDirectory(String libraryDirectory);
/**
* Returns the library-directory element
* @return the node defined for the element library-directory
*/
public String getLibraryDirectory();
/**
* Removes the library-directory element
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor removeLibraryDirectory();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: xsd:token ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
public static final String VERSION = "5";
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public String getVersion();
/**
* Removes the version attribute
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ApplicationDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor id(String id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id attribute
* @return the current instance of ApplicationDescriptor
*/
public ApplicationDescriptor removeId();
}