Package org.eclipse.steady.java

Class JavaId

java.lang.Object

org.eclipse.steady.ConstructId

org.eclipse.steady.java.JavaId

All Implemented Interfaces:

Comparable<ConstructId>

Direct Known Subclasses:

JavaClassId, JavaClassInit, JavaConstructorId, JavaEnumId, JavaInterfaceId, JavaMethodId, JavaPackageId

public abstract class JavaId
extends ConstructId

Abstract JavaId class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaId.Type	Supported Java programming constructs.

Field Summary

Fields

Modifier and Type	Field	Description
protected JavaId.Type	type	Programming language of the construct.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaId(JavaId.Type _t)	Constructor for JavaId.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(String _a)	addAnnotation.
boolean	equals(Object obj)
static Set<ConstructId>	filter(Set<ConstructId> _set, String _filter)	Returns all JavaIds whose qualified name starts with the given string.
static Set<ConstructId>	filter(Set<ConstructId> _set, String[] _filter)	Returns all JavaIds whose qualified name starts with any of the given strings.
static Set<ConstructId>	filter(Set<ConstructId> _set, JavaId.Type[] _filter)	Returns all JavaIds of the given type(s).
static Set<ConstructId>	filterWithContext(Set<ConstructId> _set, JavaId _context)	Returns all JavaMethodIds and JavaConstructorIds belonging to the given class.
Set<String>	getAnnotations()	Getter for the field annotations.
static JavaClassId	getClassId(Class _c)	Returns a JavaClassId for the given Class.
JavaId	getCompilationUnit()	Returns the JavaId corresponding to the compilation unit of the construct.
static JavaId	getCompilationUnit(JavaId _jid)	getCompilationUnit.
abstract ConstructId	getDefinitionContext()	getDefinitionContext.
URL	getJarUrl()	Returns the URL of the JAR from which the construct was loaded, or null if it is a package or has not been loaded from a JAR.
static URL	getJarUrl(URL _url)	Transform URLs like "jar:file:/.../foo.jar!bar.class" into "file:/.../foo.jar".
static JavaId	getJavaId(String _type, String _qname)	getJavaId.
abstract JavaPackageId	getJavaPackageId()	Returns the Java package in the context of which the construct is defined.
org.eclipse.steady.shared.enums.ConstructType	getSharedType()	getSharedType.
JavaId.Type	getType()	Getter for the field type.
boolean	hasAnnotation(String _a)	hasAnnotation.
int	hashCode()
protected static String	parameterTypesToString(List<String> _p)	parameterTypesToString.
protected static String	parameterTypesToString(List<String> _p, boolean _rem_qualification)	parameterTypesToString.
static JavaClassInit	parseClassInitQName(String _s)	parseClassInitQName.
static JavaClassId	parseClassQName(String _s)	parseClassQName.
static JavaConstructorId	parseConstructorQName(String _s)	Creates a JavaConstructorId from the given string, whereby the definition context is defaulted to type JavaId.Type.CLASS.
static JavaConstructorId	parseConstructorQName(JavaId.Type _ctx_type, String _s, String _param_to_skip)	Creates a JavaConstructorId from the given string, with a definition context of the given type.
static JavaEnumId	parseEnumQName(String _s)	parseEnumQName.
static JavaMethodId	parseMethodQName(String _s)	Creates a JavaMethodId from the given string, whereby the definition context is defaulted to type JavaId.Type.CLASS.
static JavaMethodId	parseMethodQName(JavaId.Type _ctx_type, String _s)	Creates a JavaMethodId from the given string, with a definition context of the given type.
static String	removePackageContext(String _qname)	Removes package information (if any) from a fully qualified name, and returns the resulting class (or interface) name.
static Set<ConstructId>	toCoreType(Collection<org.eclipse.steady.shared.json.model.ConstructId> _cids)	Transforms a collection of objects with a given shared type (defined in vulas-share) into a HashSet of objects having the corresponding core type (defined in vulas-core).
static ConstructId	toCoreType(org.eclipse.steady.shared.json.model.ConstructId _cid)	Transforms an object with a given shared type (defined in vulas-share) into an object having the corresponding core type (defined in vulas-core).
com.google.gson.JsonObject	toGSON()
String	toJSON()	toJSON.
static org.eclipse.steady.shared.enums.ConstructType	toSharedType(JavaId.Type _core_type)	Transforms an object with a given core type (defined in vulas-core) into an object having the corresponding shared type (defined in vulas-share).
String	toString()	toString.
static JavaId.Type	typeFromString(String _t)	typeFromString.
static String	typeToString(JavaId.Type _t)	typeToString.

Methods inherited from class org.eclipse.steady.ConstructId

compareTo, getLanguage, getName, getQualifiedName, getSharedType, getSimpleName, toSharedType

Methods inherited from class java.lang.Object

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

Field Detail

type

protected JavaId.Type type

Programming language of the construct.

Constructor Detail

JavaId

protected JavaId(JavaId.Type _t)

Constructor for JavaId.

Parameters:

_t - a JavaId.Type object.

Method Detail

getType

public JavaId.Type getType()

Getter for the field type.

Returns:

a JavaId.Type object.

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object.

getAnnotations

public Set<String> getAnnotations()

Getter for the field annotations.

Returns:

a Set object.

addAnnotation

public void addAnnotation(String _a)

addAnnotation.

Parameters:

_a - a String object.

hasAnnotation

public boolean hasAnnotation(String _a)

hasAnnotation.

Parameters:

_a - a String object.

Returns:

a boolean.

getJavaPackageId

public abstract JavaPackageId getJavaPackageId()

Returns the Java package in the context of which the construct is defined.

Returns:

a JavaPackageId object.

getDefinitionContext

public abstract ConstructId getDefinitionContext()

getDefinitionContext.

Specified by:

getDefinitionContext in class ConstructId

Returns:

a ConstructId object.

getSharedType

public org.eclipse.steady.shared.enums.ConstructType getSharedType()

getSharedType.

Specified by:

getSharedType in class ConstructId

Returns:

a ConstructType object.

toJSON

public final String toJSON()

toJSON.

Specified by:

toJSON in class ConstructId

Returns:

a String object.

toGSON

public com.google.gson.JsonObject toGSON()

Specified by:

toGSON in class ConstructId

hashCode

public final int hashCode()

Overrides:

hashCode in class ConstructId

equals

public final boolean equals(Object obj)

Overrides:

equals in class ConstructId

parameterTypesToString

protected static String parameterTypesToString(List<String> _p)

parameterTypesToString.

Parameters:

_p - a List object.

Returns:

Comma-separated parameter types

parameterTypesToString

protected static String parameterTypesToString(List<String> _p,
                                               boolean _rem_qualification)

parameterTypesToString.

Parameters:

_p - a List object.

_rem_qualification - a boolean.

Returns:

Comma-separated parameter types

typeToString

public static String typeToString(JavaId.Type _t)

typeToString.

Parameters:

_t - a JavaId.Type object.

Returns:

a String object.

typeFromString

public static JavaId.Type typeFromString(String _t)

typeFromString.

Parameters:

_t - a String object.

Returns:

a JavaId.Type object.

toSharedType

public static org.eclipse.steady.shared.enums.ConstructType toSharedType(JavaId.Type _core_type)

Transforms an object with a given core type (defined in vulas-core) into an object having the corresponding shared type (defined in vulas-share).

Parameters:

_core_type - a JavaId.Type object.

Returns:

a ConstructType object.

toCoreType

public static ConstructId toCoreType(org.eclipse.steady.shared.json.model.ConstructId _cid)

Transforms an object with a given shared type (defined in vulas-share) into an object having the corresponding core type (defined in vulas-core).

Parameters:

_cid - a ConstructId object.

Returns:

a ConstructId object.

toCoreType

public static Set<ConstructId> toCoreType(Collection<org.eclipse.steady.shared.json.model.ConstructId> _cids)

Transforms a collection of objects with a given shared type (defined in vulas-share) into a HashSet of objects having the corresponding core type (defined in vulas-core).

Parameters:

_cids - a Collection object.

Returns:

a Set object.

getClassId

public static JavaClassId getClassId(@NotNull
                                     Class _c)

Returns a JavaClassId for the given Class.

Parameters:

_c - a Class object.

Returns:

a JavaClassId object.

parseEnumQName

public static JavaEnumId parseEnumQName(@NotNull
                                        String _s)

parseEnumQName.

Parameters:

_s - a String object.

Returns:

a JavaEnumId object.

parseClassQName

public static JavaClassId parseClassQName(@NotNull
                                          String _s)

parseClassQName.

Parameters:

_s - a String object.

Returns:

a JavaClassId object.

parseMethodQName

public static JavaMethodId parseMethodQName(String _s)

Creates a JavaMethodId from the given string, whereby the definition context is defaulted to type JavaId.Type.CLASS.

Parameters:

_s - a String object.

Returns:

a JavaMethodId object.

parseMethodQName

public static JavaMethodId parseMethodQName(JavaId.Type _ctx_type,
                                            String _s)

Creates a JavaMethodId from the given string, with a definition context of the given type. Accepted types are JavaId.Type.CLASS and JavaId.Type.ENUM.

Parameters:

_s - a String object.

_ctx_type - a JavaId.Type object.

Returns:

a JavaMethodId object.

parseConstructorQName

public static JavaConstructorId parseConstructorQName(String _s)

Creates a JavaConstructorId from the given string, whereby the definition context is defaulted to type JavaId.Type.CLASS.

Parameters:

_s - a String object.

Returns:

a JavaConstructorId object.

parseConstructorQName

public static JavaConstructorId parseConstructorQName(JavaId.Type _ctx_type,
                                                      String _s,
                                                      String _param_to_skip)

Creates a JavaConstructorId from the given string, with a definition context of the given type. Accepted types are JavaId.Type.CLASS and JavaId.Type.ENUM. If the boolean argument is true, the first constructor parameter will be ignored. This functionality is useful for non-static inner classes, to which the compiler adds the outer class as first parameter.

Parameters:

_s - a String object.

_ctx_type - a JavaId.Type object.

_param_to_skip - a String object.

Returns:

a JavaConstructorId object.

parseClassInitQName

public static JavaClassInit parseClassInitQName(String _s)

parseClassInitQName.

Parameters:

_s - a String object.

Returns:

a JavaClassInit object.

removePackageContext

public static String removePackageContext(String _qname)

Removes package information (if any) from a fully qualified name, and returns the resulting class (or interface) name.

Parameters:

_qname - a String object.

Returns:

a String object.

filter

public static Set<ConstructId> filter(Set<ConstructId> _set,
                                      String[] _filter)

Returns all JavaIds whose qualified name starts with any of the given strings.

Parameters:

_set - a Set object.

_filter - an array of String objects.

Returns:

a Set object.

filter

public static Set<ConstructId> filter(Set<ConstructId> _set,
                                      String _filter)

Returns all JavaIds whose qualified name starts with the given string.

Parameters:

_set - a Set object.

_filter - a String object.

Returns:

a Set object.

filter

public static Set<ConstructId> filter(Set<ConstructId> _set,
                                      JavaId.Type[] _filter)

Returns all JavaIds of the given type(s).

Parameters:

_set - a Set object.

_filter - an array of JavaId.Type objects.

Returns:

a Set object.

filterWithContext

public static Set<ConstructId> filterWithContext(Set<ConstructId> _set,
                                                 JavaId _context)

Returns all JavaMethodIds and JavaConstructorIds belonging to the given class.

Parameters:

_set - a Set object.

_context - a JavaId object.

Returns:

a Set object.

getJarUrl

public URL getJarUrl()

Returns the URL of the JAR from which the construct was loaded, or null if it is a package or has not been loaded from a JAR. The URL has the form "file:/.../foo.jar", hence, it can be transformed into a URI and File. First, it uses ClassPoolUpdater.getJarResourcePath(ConstructId) to search for the JAR URL, hence, ClassPoolUpdater should contain all the needed resources. If that fails, it uses Class.forName(String) and Class.getResource(String) to search for the JAR URL.

Returns:

the URL from which the construct was loaded

getJarUrl

public static final URL getJarUrl(URL _url)
                           throws MalformedURLException

Transform URLs like "jar:file:/.../foo.jar!bar.class" into "file:/.../foo.jar".

Parameters:

_url - a URL object.

Returns:

a URL object.

Throws:

MalformedURLException - if any.

getCompilationUnit

public JavaId getCompilationUnit()

Returns the JavaId corresponding to the compilation unit of the construct. If the construct is an interface, class or enum, the object is returned as is. If the construct is a method, constructor or static initializer, its definition context will be returned (hence, an interface, class or enum). If the construct is a package, null will be returned.

Returns:

a JavaId object.

getCompilationUnit

public static JavaId getCompilationUnit(JavaId _jid)

getCompilationUnit.

Parameters:

_jid - a JavaId object

Returns:

a JavaId object

getJavaId

public static JavaId getJavaId(String _type,
                               String _qname)

getJavaId.

Parameters:

_type - a String object

_qname - a String object

Returns:

a JavaId object