Package org.checkerframework.afu.annotator.find

Class ConstructorInsertion

java.lang.Object

org.checkerframework.afu.annotator.find.Insertion

org.checkerframework.afu.annotator.find.TypedInsertion

org.checkerframework.afu.annotator.find.ConstructorInsertion

public class ConstructorInsertion
extends TypedInsertion

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.afu.annotator.find.Insertion

Insertion.Kind

Field Summary

Fields inherited from class org.checkerframework.afu.annotator.find.TypedInsertion

annotationsOnly, innerTypeInsertions, type

Fields inherited from class org.checkerframework.afu.annotator.find.Insertion

alwaysQualify, packageNames

Constructor Summary

Constructors

Constructor	Description
ConstructorInsertion(Type type, Criteria criteria, List<Insertion> innerTypeInsertions)	Construct a ConstructorInsertion.

Method Summary

Modifier and Type	Method	Description
void	addDeclarationInsertion(Insertion ins)
protected boolean	addLeadingSpace(boolean gotSeparateLine, int pos, char precedingChar)	Indicates if a preceding space should be added to this insertion.
void	addReceiverInsertion(ReceiverInsertion recv)
protected boolean	addTrailingSpace(boolean gotSeparateLine)	Indicates if a trailing space should be added to this insertion.
Insertion.Kind	getKind()	Gets the kind of this insertion.
protected ReceiverInsertion	getReceiverInsertion()
protected String	getText(boolean abbreviate)	Gets the insertion text.
void	setInserted(boolean inserted)	Sets whether this insertion has already been inserted into source code.
String	toString()

Methods inherited from class org.checkerframework.afu.annotator.find.TypedInsertion

getBaseType, getBaseType, getInnerTypeInsertions, getType, setAnnotationsOnly, setType

Methods inherited from class org.checkerframework.afu.annotator.find.Insertion

collectionToString, decorateType, decorateType, getAlwaysQualify, getCriteria, getPackageNames, getText, getText, isInserted, isSeparateLine, removePackage, setAlwaysQualify, toStringWithoutClass, typeToString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ConstructorInsertion

public ConstructorInsertion(Type type,
 Criteria criteria,
 List<Insertion> innerTypeInsertions)

Construct a ConstructorInsertion.

To insert the annotation and the constructor (for example, @Anno Type this) the name should be set to the type to insert. This can either be done before calling this constructor, or by modifying the return value of TypedInsertion.getType().

Parameters:

type - the type to use when inserting the constructor

criteria - where to insert the text

innerTypeInsertions - the inner types to go on this constructor

Method Details

getText

protected String getText(boolean abbreviate)

Description copied from class: Insertion

Gets the insertion text.

Specified by:

getText in class Insertion

Parameters:

abbreviate - if true, the package name will be removed from the annotations. The package name can be retrieved again by calling the Insertion.getPackageNames() method.

Returns:

the text to insert

getReceiverInsertion

protected ReceiverInsertion getReceiverInsertion()

addReceiverInsertion

public void addReceiverInsertion(ReceiverInsertion recv)

addDeclarationInsertion

public void addDeclarationInsertion(Insertion ins)

addLeadingSpace

protected boolean addLeadingSpace(boolean gotSeparateLine,
 int pos,
 char precedingChar)

Description copied from class: Insertion

Indicates if a preceding space should be added to this insertion. Subclasses may override this method for custom leading space rules.

Overrides:

addLeadingSpace in class Insertion

Parameters:

gotSeparateLine - true if this insertion is actually added on a separate line

pos - the source position where this insertion will be inserted

precedingChar - the character directly preceding where this insertion will be inserted. This value will be ignored if pos is 0.

Returns:

true if a leading space should be added, false otherwise

addTrailingSpace

protected boolean addTrailingSpace(boolean gotSeparateLine)

Description copied from class: Insertion

Indicates if a trailing space should be added to this insertion. Subclasses may override this method for custom trailing space rules.

Overrides:

addTrailingSpace in class Insertion

Parameters:

gotSeparateLine - true if this insertion is actually added on a separate line

Returns:

true if a trailing space should be added, false otherwise

getKind

public Insertion.Kind getKind()

Description copied from class: Insertion

Gets the kind of this insertion.

Specified by:

getKind in class Insertion

Returns:

the kind of this insertion

setInserted

public void setInserted(boolean inserted)

Sets whether this insertion has already been inserted into source code.

Overrides:

setInserted in class Insertion

Parameters:

inserted - true if this insertion has already been inserted, false otherwise

toString

public String toString()

Overrides:

toString in class Insertion