cz.ues.platform.container.utils

Class UESNamespaceHelper

java.lang.Object

cz.ues.platform.container.utils.UESNamespaceHelper

public final class UESNamespaceHelper
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UESNamespaceHelper() UESNamespaceHelper is utility class and will be never instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.Package	getAnotatedPackage(java.lang.String pkg, java.lang.Class<? extends java.lang.annotation.Annotation> anot, java.lang.ClassLoader classLoader) Recursively searches for package annotated by specified annotation.
static java.lang.String	getUESNamespace(java.lang.Class<?> compCls, java.lang.String namePartsSeparator)
private static java.lang.String	getUESNamespace(java.lang.String pkg, java.lang.Class<? extends java.lang.annotation.Annotation> anot, boolean optional)

Methods inherited from class java.lang.Object

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

Constructor Detail

UESNamespaceHelper

private UESNamespaceHelper()

UESNamespaceHelper is utility class and will be never instantiated.

Since:

UES6-02

Method Detail

getUESNamespace

public static java.lang.String getUESNamespace(java.lang.Class<?> compCls,
java.lang.String namePartsSeparator)

getUESNamespace

private static java.lang.String getUESNamespace(java.lang.String pkg,
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-02

getAnotatedPackage

private static java.lang.Package getAnotatedPackage(java.lang.String pkg,
java.lang.Class<? extends java.lang.annotation.Annotation> anot,
java.lang.ClassLoader classLoader)

Recursively searches for package annotated by specified annotation. Starts with the most qualified name of the package and than cuts off the leaf and repeats the search until the package root is reached.

Parameters:

pkgName - The qualified name of package, where to start search for annotation.

anot - The annotation to be searched on packages. (IS declared in package-info.java file)

classLoader - Used to obtain package-info class. Null could be passed to use current thread context classloader.

Returns:

The package The found package or NULL when root was reached and the annotation was not found.

Since:

UES6-02