org.eclipse.golo.compiler

Class PackageAndClass

java.lang.Object

org.eclipse.golo.compiler.PackageAndClass

public final class PackageAndClass
extends java.lang.Object

Represents a package and class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	className()
PackageAndClass	createInnerClass(java.lang.String name) Create an inner class.
PackageAndClass	createSiblingClass(java.lang.String name) Create a sibling class.
PackageAndClass	createSubPackage(java.lang.String name) Create a sub-package.
boolean	equals(java.lang.Object o)
java.lang.String	getFilename()
int	hashCode()
boolean	hasPackage() Check if this PackageAndClass has a package component.
PackageAndClass	inPackage(PackageAndClass parent) Create a class in the same package as another one.
PackageAndClass	inPackage(java.lang.String qualifiedName) Create a class in another package.
java.lang.String	mangledName()
static PackageAndClass	of(java.lang.Object o) Creates a PackageAndClass.
java.lang.String	packageName()
PackageAndClass	parentPackage()
java.lang.String	toJVMRef()
java.lang.String	toJVMType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static PackageAndClass of(java.lang.Object o)

Creates a PackageAndClass. Extracts the name from the given object.

Parameters:

o - a String, PackageAndClass, Class, GoloType or GoloModule instance.

createInnerClass

public PackageAndClass createInnerClass(java.lang.String name)

Create an inner class.

For instance:

 PackageAndClass cls = new PackageAndClass("foo.bar", "Spam");
 PackageAndClass inner = cls.createInnerClass("Egg"); // foo.bar.Spam$Egg
 

Parameters:

name - the name of the inner class.

Returns:

a new PackageAndClass identifying an inner class of this class.

createSiblingClass

public PackageAndClass createSiblingClass(java.lang.String name)

Create a sibling class.

For instance:

  PackageAndClass list = new PackageAndClass("java.util", "List");
  PackageAndClass set = list.createSiblingClass("Set"); // java.util.Set
 

Returns:

a new PackageAndClass identifying an alternate class in the same package.

createSubPackage

public PackageAndClass createSubPackage(java.lang.String name)

Create a sub-package.

For instance:

  PackageAndClass pc = new PackageAndClass("foo.bar", "Module");
  PackageAndClass sub = pc.createSubPackage("types"); // foo.bar.Modules.types
 

Returns:

a new PackageAndClass identifying a sub-package of this package.

inPackage

public PackageAndClass inPackage(java.lang.String qualifiedName)

Create a class in another package.

For instance:

 PackageAndClass pc = PackageAndClass.fromString("foo.bar.Baz");
 PackageAndClass other = pc.inPackage("plic.ploc"); // plic.ploc.Baz
 

Parameters:

qualifiedName - the qualified name of the new package.

Returns:

a new PackageAndClass representing the same class in another package.

inPackage

public PackageAndClass inPackage(PackageAndClass parent)

Create a class in the same package as another one.

For instance:

 PackageAndClass pc = PackageAndClass.fromString("foo.bar.Baz");
 PackageAndClass other = PackageAndClass.fromString("plic.ploc.Foo");
 PackageAndClass newOne = pc.inPackage(other); // plic.ploc.Baz
 

Parameters:

parent - the PackageAndClass representing the new package.

Returns:

a new PackageAndClass representing the same class in another package.

packageName

public java.lang.String packageName()

Returns:

the package name.

hasPackage

public boolean hasPackage()

Check if this PackageAndClass has a package component.

parentPackage

public PackageAndClass parentPackage()

Returns:

the package as a PackageAndClass

className

public java.lang.String className()

Returns:

the class name.

getFilename

public java.lang.String getFilename()

Returns:

the path of the corresponding class file.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJVMType

public java.lang.String toJVMType()

Returns:

a JVM type representation for this object, e.g.: foo.Bar gives foo/Bar.

toJVMRef

public java.lang.String toJVMRef()

Returns:

a JVM reference type representation for this object, e.g.: foo.Bar gives Lfoo/Bar;

mangledName

public java.lang.String mangledName()

Returns:

a mangled named for this class.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object