com.aaronicsubstances.code.augmentor.core.models

Class AugmentingCode

java.lang.Object

com.aaronicsubstances.code.augmentor.core.models.AugmentingCode

public class AugmentingCode
extends java.lang.Object

Represents contents of an augmenting code section.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AugmentingCode.Block Represents a contiguous block of lines in an augmenting code section which is either an embedded string section, an embedded JSON section, or not an embedded section.

Constructor Summary

Constructors

Constructor and Description
AugmentingCode()
AugmentingCode(java.util.List<AugmentingCode.Block> blocks)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.Object>	getArgs()
java.util.List<AugmentingCode.Block>	getBlocks()
java.lang.String	getDirectiveMarker()
int	getEndLineNumber()
java.lang.String	getExternalNestedContent()
java.lang.Integer	getGenCodeEndLineNumber()
java.lang.String	getGenCodeIndent()
java.lang.Integer	getGenCodeLineNumber()
boolean	getHasNestedLevelEndMarker()
boolean	getHasNestedLevelStartMarker()
int	getId()
java.lang.String	getIndent()
int	getLineNumber()
java.lang.String	getLineSeparator()
java.lang.Integer	getMatchingNestedLevelEndMarkerIndex()
java.lang.Integer	getMatchingNestedLevelStartMarkerIndex()
int	getNestedLevelNumber()
int	hashCode()
boolean	isProcessed()
void	setArgs(java.util.List<java.lang.Object> args) This property is not serialized into files, and is only available during processing stage.
void	setBlocks(java.util.List<AugmentingCode.Block> blocks) Sets the blocks an augmenting code section is made up of.
void	setDirectiveMarker(java.lang.String directiveMarker) Sets the text of the directive used to identify the first block of an augmenting code section.
void	setEndLineNumber(int endLineNumber) Sets the line number of the last line of an augmenting code section.
void	setExternalNestedContent(java.lang.String externalNestedContent) Sets the portion of the file this augmenting code section belongs to from the end of this augmenting code, to just before the start of the augmenting code section which ends the nested level started by this object.
void	setGenCodeEndLineNumber(java.lang.Integer genCodeEndLineNumber) Sets the line number of the last line of the generated code section existing for this augmenting code object.
void	setGenCodeIndent(java.lang.String genCodeIndent) Sets the whitespace prefix of the lines of the generated code section corresponding to an augmenting code section which has the shortest length.
void	setGenCodeLineNumber(java.lang.Integer genCodeLineNumber) Sets the line number of the first line of the generated code section existing for this augmenting code object.
void	setHasNestedLevelEndMarker(boolean hasNestedLevelEndMarker) Sets the property that identifies an augmenting code section as an end to the current nested level.
void	setHasNestedLevelStartMarker(boolean hasNestedLevelStartMarker) Sets the property that identifies an augmenting code section as a start of a new nested level.
void	setId(int id) Sets the positive integer uniquely identifying an augmenting code section in its file.
void	setIndent(java.lang.String indent) Sets the whitespace prefix of the lines of an augmenting code section with the minimum length.
void	setLineNumber(int lineNumber) Sets the line number of the first line of an augmenting code section.
void	setLineSeparator(java.lang.String lineSeparator) Sets the line terminator of the first line of an augmenting code section.
void	setMatchingNestedLevelEndMarkerIndex(java.lang.Integer matchingNestedLevelEndMarkerIndex) This property is applicable only to augmenting code sections which have nested level start markers.
void	setMatchingNestedLevelStartMarkerIndex(java.lang.Integer matchingNestedLevelStartMarkerIndex) This property is applicable only to augmenting code sections which have nested level end markers.
void	setNestedLevelNumber(int nestedLevelNumber) Sets the nested level number assigned to an augmenting code section.
void	setProcessed(boolean processed) This property is not serialized into files, and is only available during processing stage.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AugmentingCode

public AugmentingCode()

AugmentingCode

public AugmentingCode(java.util.List<AugmentingCode.Block> blocks)

Method Detail

getId

public int getId()

setId

public void setId(int id)

Sets the positive integer uniquely identifying an augmenting code section in its file.

Parameters:

id -

getBlocks

public java.util.List<AugmentingCode.Block> getBlocks()

setBlocks

public void setBlocks(java.util.List<AugmentingCode.Block> blocks)

Sets the blocks an augmenting code section is made up of.

Parameters:

blocks -

getDirectiveMarker

public java.lang.String getDirectiveMarker()

setDirectiveMarker

public void setDirectiveMarker(java.lang.String directiveMarker)

Sets the text of the directive used to identify the first block of an augmenting code section.

Parameters:

directiveMarker -

getIndent

public java.lang.String getIndent()

setIndent

public void setIndent(java.lang.String indent)

Sets the whitespace prefix of the lines of an augmenting code section with the minimum length.

Parameters:

indent -

getLineNumber

public int getLineNumber()

setLineNumber

public void setLineNumber(int lineNumber)

Sets the line number of the first line of an augmenting code section. Line numbers are positive.

Parameters:

lineNumber -

getEndLineNumber

public int getEndLineNumber()

setEndLineNumber

public void setEndLineNumber(int endLineNumber)

Sets the line number of the last line of an augmenting code section. Line numbers are positive.

Parameters:

endLineNumber -

getLineSeparator

public java.lang.String getLineSeparator()

setLineSeparator

public void setLineSeparator(java.lang.String lineSeparator)

Sets the line terminator of the first line of an augmenting code section. Every line of an augmenting code section must end with a new line.

Parameters:

lineSeparator - the newline ending the first line of this augmenting code section.

getNestedLevelNumber

public int getNestedLevelNumber()

setNestedLevelNumber

public void setNestedLevelNumber(int nestedLevelNumber)

Sets the nested level number assigned to an augmenting code section. Nested level numbers start from 0 and are increased by 1 after a augmenting code section with a nested level start marker is encountered. It is decreased by 1 upon encountering an augmenting code section with a nested level end marker.

Parameters:

nestedLevelNumber -

getArgs

public java.util.List<java.lang.Object> getArgs()

setArgs

public void setArgs(java.util.List<java.lang.Object> args)

This property is not serialized into files, and is only available during processing stage. It is used to conveniently provide processing stage functions with the embedded string or JSON blocks, in which JSON blocks are parsed.

Parameters:

args -

isProcessed

public boolean isProcessed()

setProcessed

public void setProcessed(boolean processed)

This property is not serialized into files, and is only available during processing stage. When processing stage encounters this property set to true it skips over the augmenting code and does not pass it to any processing stage function. This property is also used internally during processing stage function to skip augmenting code objects which have been processed ahead of iteration time by processing stage scripts.

Parameters:

processed -

getHasNestedLevelStartMarker

public boolean getHasNestedLevelStartMarker()

setHasNestedLevelStartMarker

public void setHasNestedLevelStartMarker(boolean hasNestedLevelStartMarker)

Sets the property that identifies an augmenting code section as a start of a new nested level.

Parameters:

hasNestedLevelStartMarker - true if this augmenting code section starts a nested level; false if it does not.

getHasNestedLevelEndMarker

public boolean getHasNestedLevelEndMarker()

setHasNestedLevelEndMarker

public void setHasNestedLevelEndMarker(boolean hasNestedLevelEndMarker)

Sets the property that identifies an augmenting code section as an end to the current nested level.

Parameters:

hasNestedLevelEndMarker - true if this augmenting code section ends current nested level; false if it does not.

getMatchingNestedLevelStartMarkerIndex

public java.lang.Integer getMatchingNestedLevelStartMarkerIndex()

setMatchingNestedLevelStartMarkerIndex

public void setMatchingNestedLevelStartMarkerIndex(java.lang.Integer matchingNestedLevelStartMarkerIndex)

This property is applicable only to augmenting code sections which have nested level end markers. It provides convenience to processing stage by setting the index of the corresponding augmenting code section in containing file which started the nested level that is being ended.

Parameters:

matchingNestedLevelStartMarkerIndex - index of augmenting code section in the same file which started the nested level this object is ending; null if not applicable.

getMatchingNestedLevelEndMarkerIndex

public java.lang.Integer getMatchingNestedLevelEndMarkerIndex()

setMatchingNestedLevelEndMarkerIndex

public void setMatchingNestedLevelEndMarkerIndex(java.lang.Integer matchingNestedLevelEndMarkerIndex)

This property is applicable only to augmenting code sections which have nested level start markers. It provides convenience to processing stage by setting the index of the corresponding augmenting code section in containing file which ends the nested level that has being started.

Parameters:

matchingNestedLevelEndMarkerIndex - index of augmenting code section in the same file which ends the nested level this object is starting; null if not applicable.

getExternalNestedContent

public java.lang.String getExternalNestedContent()

setExternalNestedContent

public void setExternalNestedContent(java.lang.String externalNestedContent)

Sets the portion of the file this augmenting code section belongs to from the end of this augmenting code, to just before the start of the augmenting code section which ends the nested level started by this object. For other objects not starting a nested level, set to null.

Parameters:

externalNestedContent -

getGenCodeIndent

public java.lang.String getGenCodeIndent()

setGenCodeIndent

public void setGenCodeIndent(java.lang.String genCodeIndent)

Sets the whitespace prefix of the lines of the generated code section corresponding to an augmenting code section which has the shortest length. If augmenting code section does not currently have a generated code section, set to null.

Parameters:

genCodeIndent -

getGenCodeLineNumber

public java.lang.Integer getGenCodeLineNumber()

setGenCodeLineNumber

public void setGenCodeLineNumber(java.lang.Integer genCodeLineNumber)

Sets the line number of the first line of the generated code section existing for this augmenting code object. Set to null if no generated code section exists yet.

Parameters:

genCodeLineNumber -

getGenCodeEndLineNumber

public java.lang.Integer getGenCodeEndLineNumber()

setGenCodeEndLineNumber

public void setGenCodeEndLineNumber(java.lang.Integer genCodeEndLineNumber)

Sets the line number of the last line of the generated code section existing for this augmenting code object. Set to null if no generated code section exists yet.

Parameters:

genCodeEndLineNumber -

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