All Superinterfaces:

WithTagValuesOrStereotypes

All Known Implementing Classes:

ObjectModelPackageImpl
```
public interface ObjectModelPackage
extends WithTagValuesOrStereotypes
```
Created on 7/6/14.

Since:

2.12

Author:

Tony Chemit - chemit@codelutin.com

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ObjectModelClass`	`getClass(String simpleName)`	Returns the class corresponding to the given qualified name, or null if the package contains no class for this simple name.
`Iterable<ObjectModelClass>`	`getClasses()`	Returns all classes defined in this package.
`ObjectModelClassifier`	`getClassifier(String simpleName)`	Returns the classifier corresponding to the given simple name, or null if the package contains no classifier for this simple name.
`Iterable<ObjectModelClassifier>`	`getClassifiers()`	Returns all classifiers defined in this package.
`List<String>`	`getComments()`	Returns all comments not lied to a particular package element
`String`	`getDescription()`	The description of this element is the upper part of the element's documentation.
`String`	`getDocumentation()`	Returns the whole documentation associated with this element (description + source documentation).
`ObjectModelEnumeration`	`getEnumeration(String simpleName)`	Return the enumeration corresponding to the given simple name
`Iterable<ObjectModelEnumeration>`	`getEnumerations()`	Returns all enumerations defined in this package.
`ObjectModelInterface`	`getInterface(String simpleName)`	Returns the interface corresponding to the given qualified name, or null if the package contains no interface for this simple name.
`Iterable<ObjectModelInterface>`	`getInterfaces()`	Returns all interfaces defined in this package.
`String`	`getName()`
`int`	`getNumberOfSubPackages()`
`Iterable<ObjectModelPackage>`	`getPackages()`	Returns all packages defined in this package.
`ObjectModelPackage`	`getParentPackage()`
`String`	`getSourceDocumentation()`	Returns the source documentation part associated with this element.
`boolean`	`hasClass(String simpleName)`	Indicates whether the package contains the class associated to the given className
`boolean`	`hasPackage(String packageName)`	Indicates whether the package contains the package associated to the given package name

Methods inherited from interface org.nuiton.eugene.models.extension.tagvalue.WithTagValuesOrStereotypes
addStereotype, addTagValue, getStereotypes, getTagValue, getTagValues, hasStereotype, hasTagValue, removeStereotype, removeTagValue

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the name of this package.
  - getNumberOfSubPackages
```
int getNumberOfSubPackages()
```
    Returns:
    
    the number of sub packages. (0 for a root package).
  - getParentPackage
```
ObjectModelPackage getParentPackage()
```
    Returns:
    
    parent package or null if the package is a root package.
  - getPackages
```
Iterable<ObjectModelPackage> getPackages()
```
    Returns all packages defined in this package.
    
    Returns:
    
    a Collection containing all ObjectModelPackages for this package.
    
    See Also:
    
    ObjectModelPackage
  - hasPackage
```
boolean hasPackage(String packageName)
```
    Indicates whether the package contains the package associated to the given package name
    
    Parameters:
    
    packageName - - the name of the package to retrieve.
    
    Returns:
    
    true if the package has been found.
  - getClassifiers
```
Iterable<ObjectModelClassifier> getClassifiers()
```
    Returns all classifiers defined in this package. (Except innerClasses)
    
    Returns:
    
    a Collection containing all ObjectModelClassifier for this package.
    
    See Also:
    
    ObjectModelClassifier
  - getClassifier
```
ObjectModelClassifier getClassifier(String simpleName)
```
    Returns the classifier corresponding to the given simple name, or null if the package contains no classifier for this simple name.
    
    Parameters:
    
    simpleName - - the qualified name of the classifier to retrieve.
    
    Returns:
    
    the ObjectModelClassifier of the found classifier, or null if the model contains no classifier for this simple name.
  - getClasses
```
Iterable<ObjectModelClass> getClasses()
```
    Returns all classes defined in this package. (Except innerClasses)
    
    Returns:
    
    a Collection containing all ObjectModelClass for this package.
    
    See Also:
    
    ObjectModelClass
  - getClass
```
ObjectModelClass getClass(String simpleName)
```
    Returns the class corresponding to the given qualified name, or null if the package contains no class for this simple name.
    
    Parameters:
    
    simpleName - - the qualified name of the class to retrieve.
    
    Returns:
    
    the ObjectModelClass of the found class, or null if the package contains no class for this simple name.
  - hasClass
```
boolean hasClass(String simpleName)
```
    Indicates whether the package contains the class associated to the given className
    
    Parameters:
    
    simpleName - - the qualified name of the class to retrieve.
    
    Returns:
    
    true if the class has been found.
  - getInterfaces
```
Iterable<ObjectModelInterface> getInterfaces()
```
    Returns all interfaces defined in this package.
    
    Returns:
    
    a Collection containing all ObjectModelInterface for this package.
    
    See Also:
    
    ObjectModelInterface
  - getInterface
```
ObjectModelInterface getInterface(String simpleName)
```
    Returns the interface corresponding to the given qualified name, or null if the package contains no interface for this simple name.
    
    Parameters:
    
    simpleName - the qualified name of the interface to retrieve.
    
    Returns:
    
    the ObjectModelInterface of the found interface, or null if the package contains no interface for this simple name.
  - getEnumerations
```
Iterable<ObjectModelEnumeration> getEnumerations()
```
    Returns all enumerations defined in this package.
    
    Returns:
    
    a Collection containing all ObjectModelEnumeration for this package.
    
    See Also:
    
    ObjectModelEnumeration
  - getEnumeration
```
ObjectModelEnumeration getEnumeration(String simpleName)
```
    Return the enumeration corresponding to the given simple name
    
    Parameters:
    
    simpleName - the fully qualified name of the enumeration to retrieve.
    
    Returns:
    
    the ObjectModelEnumeration of the found enumeration or null if the package contains no enumeration for this simple name.
  - getComments
```
List<String> getComments()
```
    Returns all comments not lied to a particular package element
    
    Returns:
    
    a List containing all comments for this package as Strings.
  - getDocumentation
```
String getDocumentation()
```
    Returns the whole documentation associated with this element (description + source documentation).
    
    Returns:
    
    the whole documentation associated with this element.
  - getDescription
```
String getDescription()
```
    The description of this element is the upper part of the element's documentation. The other part of the document can be accessed with getSourceDocumentation()
    
    Returns:
    
    the description associated with this element.
  - getSourceDocumentation
```
String getSourceDocumentation()
```
    Returns the source documentation part associated with this element. Source documentation is at end of documentation and are separated of over documentation by "--"
    
    Returns:
    
    the source documentation part associated with this element.

Interface ObjectModelPackage

Method Summary

Methods inherited from interface org.nuiton.eugene.models.extension.tagvalue.WithTagValuesOrStereotypes

Method Detail

getName

getNumberOfSubPackages

getParentPackage

getPackages

hasPackage

getClassifiers

getClassifier

getClasses

getClass

hasClass

getInterfaces

getInterface

getEnumerations

getEnumeration

getComments

getDocumentation

getDescription

getSourceDocumentation