Package org.eclipse.steady.java

Class JavaPackageId

java.lang.Object

org.eclipse.steady.ConstructId

org.eclipse.steady.java.JavaId

org.eclipse.steady.java.JavaPackageId

All Implemented Interfaces:

Comparable<ConstructId>

public class JavaPackageId
extends JavaId

Identifies a Java package by its fully qualified name.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.steady.java.JavaId

JavaId.Type

Field Summary

Fields

Modifier and Type	Field	Description
static JavaPackageId	DEFAULT_PACKAGE	The default package has an empty string as qualified name.
protected String	packageId	Fully qualified package identifier.

Fields inherited from class org.eclipse.steady.java.JavaId

type

Constructor Summary

Constructors

Constructor	Description
JavaPackageId(String _qualified_name)	Constructor for JavaPackageId.

Method Summary

Modifier and Type	Method	Description
ConstructId	getDefinitionContext()	For packages, this method always returns null.
JavaPackageId	getJavaPackageId()	For packages, this method always returns null.
String	getName()	For packages, the method returns the qualified name.
String	getQualifiedName()	Returns the complete package name, including parent packages.
String	getSimpleName()	For packages, the method returns the qualified name.
static boolean	isDefaultPackage(JavaPackageId _pid)	Returns true if the given JavaPackageId corresponds to the DEFAULT_PACKAGE, false otherwise.

Methods inherited from class org.eclipse.steady.java.JavaId

addAnnotation, equals, filter, filter, filter, filterWithContext, getAnnotations, getClassId, getCompilationUnit, getCompilationUnit, getJarUrl, getJarUrl, getJavaId, getSharedType, getType, hasAnnotation, hashCode, parameterTypesToString, parameterTypesToString, parseClassInitQName, parseClassQName, parseConstructorQName, parseConstructorQName, parseEnumQName, parseMethodQName, parseMethodQName, removePackageContext, toCoreType, toCoreType, toGSON, toJSON, toSharedType, toString, typeFromString, typeToString

Methods inherited from class org.eclipse.steady.ConstructId

compareTo, getLanguage, getSharedType, toSharedType

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PACKAGE

public static final JavaPackageId DEFAULT_PACKAGE

The default package has an empty string as qualified name. It is used when working with classes, interfaces or enums that do not belong to a package.

packageId

protected String packageId

Fully qualified package identifier.

Constructor Detail

JavaPackageId

public JavaPackageId(String _qualified_name)

Constructor for JavaPackageId.

Parameters:

_qualified_name - a String object.

Method Detail

getQualifiedName

public String getQualifiedName()

Returns the complete package name, including parent packages.

Specified by:

getQualifiedName in class ConstructId

Returns:

a String object.

getName

public String getName()

For packages, the method returns the qualified name.

Specified by:

getName in class ConstructId

Returns:

a String object.

getSimpleName

public String getSimpleName()

For packages, the method returns the qualified name.

Specified by:

getSimpleName in class ConstructId

Returns:

a String object.

getDefinitionContext

public ConstructId getDefinitionContext()

For packages, this method always returns null.

Specified by:

getDefinitionContext in class JavaId

Returns:

a ConstructId object.

getJavaPackageId

public JavaPackageId getJavaPackageId()

For packages, this method always returns null.

Specified by:

getJavaPackageId in class JavaId

Returns:

a JavaPackageId object.

isDefaultPackage

public static final boolean isDefaultPackage(JavaPackageId _pid)

Returns true if the given JavaPackageId corresponds to the DEFAULT_PACKAGE, false otherwise.

Parameters:

_pid - a JavaPackageId object.

Returns:

a boolean.