NamedEntityGraph (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, OrmNamedEntityGraphCommType<T,NamedEntityGraph<T>,NamedAttributeNode<NamedEntityGraph<T>>,NamedSubgraph<NamedEntityGraph<T>>,NamedSubgraph<NamedEntityGraph<T>>>
```
public interface NamedEntityGraph<T>
extends Child<T>, OrmNamedEntityGraphCommType<T,NamedEntityGraph<T>,NamedAttributeNode<NamedEntityGraph<T>>,NamedSubgraph<NamedEntityGraph<T>>,NamedSubgraph<NamedEntityGraph<T>>>
```
This interface defines the contract for the named-entity-graph xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NamedAttributeNode<NamedEntityGraph<T>>`	`createNamedAttributeNode()` Creates a new `named-attribute-node` element
`NamedSubgraph<NamedEntityGraph<T>>`	`createSubclassSubgraph()` Creates a new `subclass-subgraph` element
`NamedSubgraph<NamedEntityGraph<T>>`	`createSubgraph()` Creates a new `subgraph` element
`List<NamedAttributeNode<NamedEntityGraph<T>>>`	`getAllNamedAttributeNode()` Returns all `named-attribute-node` elements
`List<NamedSubgraph<NamedEntityGraph<T>>>`	`getAllSubclassSubgraph()` Returns all `subclass-subgraph` elements
`List<NamedSubgraph<NamedEntityGraph<T>>>`	`getAllSubgraph()` Returns all `subgraph` elements
`String`	`getName()` Returns the `name` attribute
`NamedAttributeNode<NamedEntityGraph<T>>`	`getOrCreateNamedAttributeNode()` If not already created, a new `named-attribute-node` element will be created and returned.
`NamedSubgraph<NamedEntityGraph<T>>`	`getOrCreateSubclassSubgraph()` If not already created, a new `subclass-subgraph` element will be created and returned.
`NamedSubgraph<NamedEntityGraph<T>>`	`getOrCreateSubgraph()` If not already created, a new `subgraph` element will be created and returned.
`NamedEntityGraph<T>`	`includeAllAttributes(Boolean includeAllAttributes)` Sets the `include-all-attributes` attribute
`Boolean`	`isIncludeAllAttributes()` Returns the `include-all-attributes` attribute
`NamedEntityGraph<T>`	`name(String name)` Sets the `name` attribute
`NamedEntityGraph<T>`	`removeAllNamedAttributeNode()` Removes all `named-attribute-node` elements
`NamedEntityGraph<T>`	`removeAllSubclassSubgraph()` Removes all `subclass-subgraph` elements
`NamedEntityGraph<T>`	`removeAllSubgraph()` Removes all `subgraph` elements
`NamedEntityGraph<T>`	`removeIncludeAllAttributes()` Removes the `include-all-attributes` attribute
`NamedEntityGraph<T>`	`removeName()` Removes the `name` attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - getOrCreateNamedAttributeNode
```
NamedAttributeNode<NamedEntityGraph<T>> getOrCreateNamedAttributeNode()
```
    If not already created, a new named-attribute-node element will be created and returned. Otherwise, the first existing named-attribute-node element will be returned.
    
    Returns:
    
    the instance defined for the element named-attribute-node
  - createNamedAttributeNode
```
NamedAttributeNode<NamedEntityGraph<T>> createNamedAttributeNode()
```
    Creates a new named-attribute-node element
    
    Returns:
    
    the new created instance of NamedAttributeNode>
  - getAllNamedAttributeNode
```
List<NamedAttributeNode<NamedEntityGraph<T>>> getAllNamedAttributeNode()
```
    Returns all named-attribute-node elements
    
    Returns:
    
    list of named-attribute-node
  - removeAllNamedAttributeNode
```
NamedEntityGraph<T> removeAllNamedAttributeNode()
```
    Removes all named-attribute-node elements
    
    Returns:
    
    the current instance of NamedAttributeNode>
  - getOrCreateSubgraph
```
NamedSubgraph<NamedEntityGraph<T>> getOrCreateSubgraph()
```
    If not already created, a new subgraph element will be created and returned. Otherwise, the first existing subgraph element will be returned.
    
    Returns:
    
    the instance defined for the element subgraph
  - createSubgraph
```
NamedSubgraph<NamedEntityGraph<T>> createSubgraph()
```
    Creates a new subgraph element
    
    Returns:
    
    the new created instance of NamedSubgraph>
  - getAllSubgraph
```
List<NamedSubgraph<NamedEntityGraph<T>>> getAllSubgraph()
```
    Returns all subgraph elements
    
    Returns:
    
    list of subgraph
  - removeAllSubgraph
```
NamedEntityGraph<T> removeAllSubgraph()
```
    Removes all subgraph elements
    
    Returns:
    
    the current instance of NamedSubgraph>
  - getOrCreateSubclassSubgraph
```
NamedSubgraph<NamedEntityGraph<T>> getOrCreateSubclassSubgraph()
```
    If not already created, a new subclass-subgraph element will be created and returned. Otherwise, the first existing subclass-subgraph element will be returned.
    
    Returns:
    
    the instance defined for the element subclass-subgraph
  - createSubclassSubgraph
```
NamedSubgraph<NamedEntityGraph<T>> createSubclassSubgraph()
```
    Creates a new subclass-subgraph element
    
    Returns:
    
    the new created instance of NamedSubgraph>
  - getAllSubclassSubgraph
```
List<NamedSubgraph<NamedEntityGraph<T>>> getAllSubclassSubgraph()
```
    Returns all subclass-subgraph elements
    
    Returns:
    
    list of subclass-subgraph
  - removeAllSubclassSubgraph
```
NamedEntityGraph<T> removeAllSubclassSubgraph()
```
    Removes all subclass-subgraph elements
    
    Returns:
    
    the current instance of NamedSubgraph>
  - name
```
NamedEntityGraph<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of NamedEntityGraph
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
NamedEntityGraph<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of NamedEntityGraph
  - includeAllAttributes
```
NamedEntityGraph<T> includeAllAttributes(Boolean includeAllAttributes)
```
    Sets the include-all-attributes attribute
    
    Parameters:
    
    includeAllAttributes - the value for the attribute include-all-attributes
    
    Returns:
    
    the current instance of NamedEntityGraph
  - isIncludeAllAttributes
```
Boolean isIncludeAllAttributes()
```
    Returns the include-all-attributes attribute
    
    Returns:
    
    the value defined for the attribute include-all-attributes
  - removeIncludeAllAttributes
```
NamedEntityGraph<T> removeIncludeAllAttributes()
```
    Removes the include-all-attributes attribute
    
    Returns:
    
    the current instance of NamedEntityGraph

Interface NamedEntityGraph<T>

Method Summary

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

Method Detail

getOrCreateNamedAttributeNode

createNamedAttributeNode

getAllNamedAttributeNode

removeAllNamedAttributeNode

getOrCreateSubgraph

createSubgraph

getAllSubgraph

removeAllSubgraph

getOrCreateSubclassSubgraph

createSubclassSubgraph

getAllSubclassSubgraph

removeAllSubclassSubgraph

name

getName

removeName

includeAllAttributes

isIncludeAllAttributes

removeIncludeAllAttributes