org.eclipse.xtend.lib.macro

Interface RegisterGlobalsContext

All Superinterfaces:

FileLocations, FileSystemSupport, SourceTypeLookup, UpstreamTypeLookup

@Beta
public interface RegisterGlobalsContext
extends FileSystemSupport, FileLocations, UpstreamTypeLookup, SourceTypeLookup

Provides services to be used during register-globals phase.

Author:

Sven Efftinge

See Also:

RegisterGlobalsParticipant

Method Summary

Methods

Modifier and Type	Method and Description
void	registerAnnotationType(String qualifiedName) Registers and creates an empty Java annotation type with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type.
void	registerClass(String qualifiedName) Registers and creates an empty Java class with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type.
void	registerEnumerationType(String qualifiedName) Registers and creates an empty Java enumeration type with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type.
void	registerInterface(String qualifiedName) Registers and creates an empty Java interface with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type.

Methods inherited from interface org.eclipse.xtend.lib.macro.file.FileSystemSupport

exists, getCharset, getChildren, getContents, getContentsAsStream, getLastModification, isFile, isFolder, toURI

Methods inherited from interface org.eclipse.xtend.lib.macro.file.FileLocations

getProjectFolder, getProjectSourceFolders, getSourceFolder, getTargetFolder

Methods inherited from interface org.eclipse.xtend.lib.macro.services.UpstreamTypeLookup

findUpstreamType, findUpstreamType

Methods inherited from interface org.eclipse.xtend.lib.macro.services.SourceTypeLookup

findSourceAnnotationType, findSourceClass, findSourceEnumerationType, findSourceInterface

Method Detail

registerClass

void registerClass(String qualifiedName)
                   throws IllegalArgumentException

Registers and creates an empty Java class with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type. For instance, given an

  // creates a type 'MyClass' in the package 'my.pack'
  registerClass("my.pack.MyClass") 
 
  // creates a type 'MyInnerClass' as a member of the type 'my.pack.MyClass'
  registerClass("my.pack.MyClass.MyInnerClass") 
 

Parameters:

qualifiedName -

Throws:

IllegalArgumentException - if the qualifiedName conflicts with any existing types.

IllegalArgumentException - if the qualifiedName is not a valid qualified name

registerInterface

void registerInterface(String qualifiedName)
                       throws IllegalArgumentException

Registers and creates an empty Java interface with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type. For instance, given an

  // creates a type 'MyClass' in the package 'my.pack'
  registerClass("my.pack.MyClass") 
 
  // creates a type 'MyInnerClass' as a member of the type 'my.pack.MyClass'
  registerClass("my.pack.MyClass.MyInnerClass") 
 

Parameters:

qualifiedName -

Throws:

IllegalArgumentException - if the qualifiedName conflicts with any existing types.

IllegalArgumentException - if the qualifiedName is not a valid qualified name

registerAnnotationType

void registerAnnotationType(String qualifiedName)
                            throws IllegalArgumentException

Registers and creates an empty Java annotation type with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type. For instance, given an

  // creates a type 'MyClass' in the package 'my.pack'
  registerClass("my.pack.MyClass") 
 
  // creates a type 'MyInnerClass' as a member of the type 'my.pack.MyClass'
  registerClass("my.pack.MyClass.MyInnerClass") 
 

Parameters:

qualifiedName -

Throws:

IllegalArgumentException - if the qualifiedName conflicts with any existing types.

IllegalArgumentException - if the qualifiedName is not a valid qualified name

registerEnumerationType

void registerEnumerationType(String qualifiedName)
                             throws IllegalArgumentException

Registers and creates an empty Java enumeration type with given qualified name If the name's namespace part refers to another derived Java type, this type will become a static member of that type. For instance, given an

  // creates a type 'MyClass' in the package 'my.pack'
  registerClass("my.pack.MyClass") 
 
  // creates a type 'MyInnerClass' as a member of the type 'my.pack.MyClass'
  registerClass("my.pack.MyClass.MyInnerClass") 
 

Parameters:

qualifiedName -

Throws:

IllegalArgumentException - if the qualifiedName conflicts with any existing types.

IllegalArgumentException - if the qualifiedName is not a valid qualified name