cz.ues.platform.apt.model

Class PackageModel

java.lang.Object

cz.ues.platform.apt.model.AbstractModel<javax.lang.model.element.PackageElement>

cz.ues.platform.apt.model.PackageModel

public class PackageModel
extends AbstractModel<javax.lang.model.element.PackageElement>

Encapsulates logic about packages.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	systemPkgName

Constructor Summary

Constructors

Constructor and Description
PackageModel(ProcessingContext ctx, javax.lang.model.element.PackageElement element) Creates a new instance of PackageModel.

Method Summary

Methods

Modifier and Type	Method and Description
private java.lang.String	getAnotatedPkgName(java.lang.String pkgName, java.lang.Class<? extends java.lang.annotation.Annotation> anot)
java.lang.String	getModuleQualifiedName()
PackageModel	getParentPackage()
java.lang.String	getQualifiedName()
private java.lang.String	getQualifiedNameFor(java.lang.Class<? extends java.lang.annotation.Annotation> anot, boolean optional)
java.lang.String	getSubmoduleQualifiedName()
private java.lang.String	getSystemPkgName()
java.lang.String	getUESNamespace()

Methods inherited from class cz.ues.platform.apt.model.AbstractModel

equals, getContext, getElement, getSimpleName, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

systemPkgName

private systemPkgName

Constructor Detail

PackageModel

public PackageModel(ProcessingContext ctx,
javax.lang.model.element.PackageElement element)

Creates a new instance of PackageModel.

Parameters:

ctx - Current processing context.

element - The packageElement to be encapsulated by this model.

Since:

UES6-00

Method Detail

getQualifiedName

public java.lang.String getQualifiedName()

Returns:

The qualified name of the package (includes parent package names).

Since:

UES6-00

getModuleQualifiedName

public java.lang.String getModuleQualifiedName()

Returns:

The name of UES module determined from package annotated by UESModule

Since:

UES6-00

getSubmoduleQualifiedName

public java.lang.String getSubmoduleQualifiedName()

getUESNamespace

public java.lang.String getUESNamespace()

getQualifiedNameFor

private java.lang.String getQualifiedNameFor(java.lang.Class<? extends java.lang.annotation.Annotation> anot,
boolean optional)

Parameters:

anot - The annotation searched on package and subpackages.

optional - Determines if the annotation is optional or mandatory - TRUE=optional and when not found, than NULL as return. FALSE=mandatory and when not found, than APTModelRTException will be thrown.

Returns:

The Qualified name part of the package annotated by specified annotation like Module,Submodule,Subsystem

Since:

UES6-00

getAnotatedPkgName

private java.lang.String getAnotatedPkgName(java.lang.String pkgName,
java.lang.Class<? extends java.lang.annotation.Annotation> anot)

getSystemPkgName

private java.lang.String getSystemPkgName()

getParentPackage

public PackageModel getParentPackage()

Returns:

The parent package model or NULL, when root was found.

Since:

UES6-00