Package org.checkerframework.afu.annotator.find

Class NewInsertion

java.lang.Object

org.checkerframework.afu.annotator.find.Insertion

org.checkerframework.afu.annotator.find.TypedInsertion

org.checkerframework.afu.annotator.find.NewInsertion

public class NewInsertion
extends TypedInsertion

Nested Class Summary

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

Insertion.Kind

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	qualifyType	If true, the type will be qualified with the name of the superclass.

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
NewInsertion(Type type, Criteria criteria, List<Insertion> innerTypeInsertions)	Construct a NewInsertion.

Method Summary

Modifier and Type	Method	Description
protected boolean	addLeadingSpace(boolean gotSeparateLine, int pos, char precedingChar)	Indicates if a preceding space should be added to this insertion.
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 String	getText(boolean abbreviate)	Gets the insertion text.
void	setQualifyType(boolean qualifyType)	If true, qualify type with the name of the superclass.

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, setInserted, toString, toStringWithoutClass, typeToString

Methods inherited from class java.lang.Object

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

Field Details

qualifyType

protected boolean qualifyType

If true, the type will be qualified with the name of the superclass.

Constructor Details

NewInsertion

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

Construct a NewInsertion.

If "new" already exists in the initializer, then pass a DeclaredType thats name is the empty String. This will only insert an annotation on the existing type.

To insert the annotation along with "new" and the type (for example, @Anno new Type[] \{...\}), set the name to the type to insert. This can be done either before calling this constructor, or by modifying the return value of TypedInsertion.getType().

Parameters:

type - the type to use when inserting the receiver

criteria - where to insert the text

innerTypeInsertions - the inner types to go on this receiver

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

setQualifyType

public void setQualifyType(boolean qualifyType)

If true, qualify type with the name of the superclass. This will only happen if a "new" is inserted.

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