com.aaronicsubstances.code.augmentor.core.models

Class GeneratedCode

java.lang.Object

com.aaronicsubstances.code.augmentor.core.models.GeneratedCode

public class GeneratedCode
extends java.lang.Object

Represents generated code objects which constitutes the contents of the output file of the processing stage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneratedCode.ContentPart Represents a section of generated code content.

Constructor Summary

Constructors

Constructor and Description
GeneratedCode()
GeneratedCode(int id, boolean disableEnsureEndingNewline, java.lang.String indent, boolean skipped, boolean replaceAugCodeDirectives, boolean replaceGenCodeDirectives, java.util.List<GeneratedCode.ContentPart> contentParts)
GeneratedCode(java.util.List<GeneratedCode.ContentPart> contentParts)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<GeneratedCode.ContentPart>	getContentParts()
int	getId()
java.lang.String	getIndent()
java.lang.String	getWholeContent() Gets generated content concatenated from content parts.
int	hashCode()
boolean	isDisableEnsureEndingNewline()
java.lang.Boolean	isPreferInline()
boolean	isReplaceAugCodeDirectives()
boolean	isReplaceGenCodeDirectives()
boolean	isSkipped()
void	setContentParts(java.util.List<GeneratedCode.ContentPart> contentParts) Sets the parts of a generated code content.
void	setDisableEnsureEndingNewline(boolean disableEnsureEndingNewline) Sets the property which prevents appending newline to generated code content not ending with one.
void	setId(int id) Sets the id of the augmenting code object to which this generated code object corresponds.
void	setIndent(java.lang.String indent) Sets the indent to apply to the generated code object.
void	setPreferInline(java.lang.Boolean preferInline) Sets the property which communicates to completion stage how to decide when using inline generated code directives.
void	setReplaceAugCodeDirectives(boolean replaceAugCodeDirectives) Sets property which directs completion stage to include augmenting code section itself in the range of source file to be replaced by generated code section.
void	setReplaceGenCodeDirectives(boolean replaceGenCodeDirectives) Sets property which directs completion stage to include generated code section itself in the range of source file to be replaced by generated code section.
void	setSkipped(boolean skipped) Sets the property which communicates to completion stage that it should skip getting and merging generated code for an augmenting code section.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratedCode

public GeneratedCode()

GeneratedCode

public GeneratedCode(java.util.List<GeneratedCode.ContentPart> contentParts)

GeneratedCode

public GeneratedCode(int id,
                     boolean disableEnsureEndingNewline,
                     java.lang.String indent,
                     boolean skipped,
                     boolean replaceAugCodeDirectives,
                     boolean replaceGenCodeDirectives,
                     java.util.List<GeneratedCode.ContentPart> contentParts)

Method Detail

getId

public int getId()

setId

public void setId(int id)

Sets the id of the augmenting code object to which this generated code object corresponds.

Parameters:

id -

getIndent

public java.lang.String getIndent()

setIndent

public void setIndent(java.lang.String indent)

Sets the indent to apply to the generated code object. If empty string, then no indentation will be applied. If null, then by default generated code section's indent will be applied if that section exists. If no generated code section is found, then as a last resort indent of augmenting code section will be used.

Parameters:

indent -

isDisableEnsureEndingNewline

public boolean isDisableEnsureEndingNewline()

setDisableEnsureEndingNewline

public void setDisableEnsureEndingNewline(boolean disableEnsureEndingNewline)

Sets the property which prevents appending newline to generated code content not ending with one. By default completion stage ensures a generated code ends with a newline by adding one when no trailing newline is found.

Parameters:

disableEnsureEndingNewline -

isSkipped

public boolean isSkipped()

setSkipped

public void setSkipped(boolean skipped)

Sets the property which communicates to completion stage that it should skip getting and merging generated code for an augmenting code section. If a file has augmenting codes, and all of them are skipped, then completion stage will never generate a file for it even if code change detection is disabled. This feature enables one to supply non-source files such as config files to processing stage, to set up global and file scopes of helper context object and perform some initialization.

Parameters:

skipped -

isReplaceAugCodeDirectives

public boolean isReplaceAugCodeDirectives()

setReplaceAugCodeDirectives

public void setReplaceAugCodeDirectives(boolean replaceAugCodeDirectives)

Sets property which directs completion stage to include augmenting code section itself in the range of source file to be replaced by generated code section. By default only generated code sections are targeted for replacement.

Parameters:

replaceAugCodeDirectives -

isReplaceGenCodeDirectives

public boolean isReplaceGenCodeDirectives()

setReplaceGenCodeDirectives

public void setReplaceGenCodeDirectives(boolean replaceGenCodeDirectives)

Sets property which directs completion stage to include generated code section itself in the range of source file to be replaced by generated code section. This resembles the default in which only generated code sections are targeted for replacement. It is different in the following way.

• It can however be combined with setReplaceAugCodeDirectives(boolean).
• It can also be used to prevent default wrapping of generated code content with generated code start/end directives. If using inline generated code directives, then this is the property that must be used to allow processing stage to dictate how generated code should wrapped.
• The range implied by this property includes the blank lines allowable between an augmenting code section and its generated code section.

Parameters:

replaceGenCodeDirectives -

isPreferInline

public java.lang.Boolean isPreferInline()

setPreferInline

public void setPreferInline(java.lang.Boolean preferInline)

Sets the property which communicates to completion stage how to decide when using inline generated code directives.

Parameters:

preferInline - the preference for inline code generation. if null, then default behaviour is used. if true, then inline generated code directives will be used if possible. Else false means that inline generated code directives is guaranteed not to be used.

getContentParts

public java.util.List<GeneratedCode.ContentPart> getContentParts()

setContentParts

public void setContentParts(java.util.List<GeneratedCode.ContentPart> contentParts)

Sets the parts of a generated code content.

getWholeContent

public java.lang.String getWholeContent()

Gets generated content concatenated from content parts.

Returns:

combined generated code content

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object