Module org.eclipse.xtend.lib.macro

Package org.eclipse.xtend.lib.macro.declaration

Interface MutableTypeDeclaration

All Superinterfaces:

AnnotationTarget, Declaration, Element, MemberDeclaration, MutableAnnotationTarget, MutableDeclaration, MutableElement, MutableMemberDeclaration, MutableNamedElement, NamedElement, Type, TypeDeclaration

All Known Subinterfaces:

MutableAnnotationTypeDeclaration, MutableClassDeclaration, MutableEnumerationTypeDeclaration, MutableInterfaceDeclaration

@Beta
public interface MutableTypeDeclaration
extends MutableMemberDeclaration, TypeDeclaration

A mutable type declaration.

Author:

Sven Efftinge

Method Summary

Modifier and Type	Method	Description
MutableConstructorDeclaration	addConstructor(org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableConstructorDeclaration> initializer)	Adds a new constructor to this type declaration.
MutableFieldDeclaration	addField(String name, org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableFieldDeclaration> initializer)	Adds a new field with the given name.
MutableMethodDeclaration	addMethod(String name, org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableMethodDeclaration> initializer)	Adds a new method with the given name to this type declaration.
MutableConstructorDeclaration	findDeclaredConstructor(TypeReference... parameterTypes)
MutableFieldDeclaration	findDeclaredField(String name)
MutableMethodDeclaration	findDeclaredMethod(String name, TypeReference... parameterTypes)
MutableTypeDeclaration	findDeclaredType(String name)
Iterable<? extends MutableAnnotationTypeDeclaration>	getDeclaredAnnotationTypes()
Iterable<? extends MutableClassDeclaration>	getDeclaredClasses()
Iterable<? extends MutableConstructorDeclaration>	getDeclaredConstructors()
Iterable<? extends MutableEnumerationTypeDeclaration>	getDeclaredEnumerationTypes()
Iterable<? extends MutableFieldDeclaration>	getDeclaredFields()
Iterable<? extends MutableInterfaceDeclaration>	getDeclaredInterfaces()
Iterable<? extends MutableMemberDeclaration>	getDeclaredMembers()
Iterable<? extends MutableMethodDeclaration>	getDeclaredMethods()
Iterable<? extends MutableTypeDeclaration>	getDeclaredTypes()
void	remove()	It is not possible to remove a type.
void	setSimpleName(String simpleName)	It is not possible to rename a type.

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.AnnotationTarget

findAnnotation, getAnnotations

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MemberDeclaration

getDocComment, getModifiers, getVisibility, isDeprecated

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableAnnotationTarget

addAnnotation, removeAnnotation

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableDeclaration

markAsRead

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableMemberDeclaration

getDeclaringType, setDeprecated, setDocComment, setVisibility

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.NamedElement

getCompilationUnit, getSimpleName

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.Type

getQualifiedName, isAssignableFrom

Method Details

getDeclaredMembers

Iterable<? extends MutableMemberDeclaration> getDeclaredMembers()

Specified by:

getDeclaredMembers in interface TypeDeclaration

Returns:

the members directly declared and contained in the type declaration

getDeclaredMethods

Iterable<? extends MutableMethodDeclaration> getDeclaredMethods()

Specified by:

getDeclaredMethods in interface TypeDeclaration

Returns:

the methods directly declared and contained in the type declaration

getDeclaredFields

Iterable<? extends MutableFieldDeclaration> getDeclaredFields()

Specified by:

getDeclaredFields in interface TypeDeclaration

Returns:

the fields directly declared and contained in the type declaration

getDeclaredConstructors

Iterable<? extends MutableConstructorDeclaration> getDeclaredConstructors()

Specified by:

getDeclaredConstructors in interface TypeDeclaration

Returns:

the constructors directly declared and contained in the type declaration

getDeclaredClasses

Iterable<? extends MutableClassDeclaration> getDeclaredClasses()

Specified by:

getDeclaredClasses in interface TypeDeclaration

Returns:

the classes directly declared and contained in the type declaration

getDeclaredInterfaces

Iterable<? extends MutableInterfaceDeclaration> getDeclaredInterfaces()

Specified by:

getDeclaredInterfaces in interface TypeDeclaration

Returns:

the interfaces directly declared and contained in the type declaration

getDeclaredEnumerationTypes

Iterable<? extends MutableEnumerationTypeDeclaration> getDeclaredEnumerationTypes()

Specified by:

getDeclaredEnumerationTypes in interface TypeDeclaration

Returns:

the enumeration types directly declared and contained in this type declaration

Since:

2.8

getDeclaredAnnotationTypes

Iterable<? extends MutableAnnotationTypeDeclaration> getDeclaredAnnotationTypes()

Specified by:

getDeclaredAnnotationTypes in interface TypeDeclaration

Returns:

the annotation types directly declared and contained in this type declaration

Since:

2.8

getDeclaredTypes

Iterable<? extends MutableTypeDeclaration> getDeclaredTypes()

Specified by:

getDeclaredTypes in interface TypeDeclaration

Returns:

the types directly declared and contained in this type declaration

Since:

2.8

findDeclaredField

MutableFieldDeclaration findDeclaredField(String name)

Specified by:

findDeclaredField in interface TypeDeclaration

Parameters:

name - of the feature

Returns:

the declared field with the given name or null of no such field exists.

findDeclaredType

MutableTypeDeclaration findDeclaredType(String name)

Specified by:

findDeclaredType in interface TypeDeclaration

Parameters:

name - of the nested type

Returns:

the declared, nested type with the given name or null of no such type exists.

Since:

2.8

findDeclaredMethod

MutableMethodDeclaration findDeclaredMethod(String name,
 TypeReference... parameterTypes)

Specified by:

findDeclaredMethod in interface TypeDeclaration

Parameters:

name - of the method

parameterTypes - - the types of the method

Returns:

the declared method with the given name and the specified parameter types or null if no such method exists.

findDeclaredConstructor

MutableConstructorDeclaration findDeclaredConstructor(TypeReference... parameterTypes)

Specified by:

findDeclaredConstructor in interface TypeDeclaration

Parameters:

parameterTypes - - the parameter types of the constructor

Returns:

the declared constructor with the exact same parameter types or null if no such constructors exists.

addField

MutableFieldDeclaration addField(String name,
 org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableFieldDeclaration> initializer)

Adds a new field with the given name.

Parameters:

name - the name of the field to be added, must be not null

initializer - a callback for further initialization of the created field, must be not null

Returns:

the created field declaration

Throws:

UnsupportedOperationException - if the underlying type declaration is not capable of containing methods.

IllegalArgumentException - if the name is not a valid java identifier or the initializer is null

addMethod

MutableMethodDeclaration addMethod(String name,
 org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableMethodDeclaration> initializer)

Adds a new method with the given name to this type declaration.

Parameters:

name - the name of the method

initializer - a call back for further initialization of the method

Returns:

the created method declaration

Throws:

UnsupportedOperationException - if the underlying type declaration is not capable of containing methods.

IllegalArgumentException - if the name is not a valid java identifier or the initializer is null

addConstructor

MutableConstructorDeclaration addConstructor(org.eclipse.xtext.xbase.lib.Procedures.Procedure1<MutableConstructorDeclaration> initializer)

Adds a new constructor to this type declaration.

Parameters:

initializer - a call back for further initialization of the constructor

Returns:

the created constructor declaration

Throws:

UnsupportedOperationException - if the underlying type declaration is not capable of containing constructors.

IllegalArgumentException - if the initializer is null

setSimpleName

void setSimpleName(String simpleName)

It is not possible to rename a type.

Specified by:

setSimpleName in interface MutableNamedElement

Parameters:

simpleName - the simple name of this element, must not be null

Throws:

UnsupportedOperationException - always

remove

void remove()

It is not possible to remove a type.

Specified by:

remove in interface MutableElement

Throws:

UnsupportedOperationException - always