|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.code.mojo.license.header.HeaderDefinition
public final class HeaderDefinition
The HeaderDefinition
class defines what is needed to output a header text into the of the given file
type and what is needed to match the first line as well as the last line of a previous header of the given file
type.
Optionally you can define the lines you want to skip before outputting the header.
Constructor Summary | |
---|---|
HeaderDefinition(String type)
Constructs a new HeaderDefinition with only initializing the header type. |
|
HeaderDefinition(String type,
String firstLine,
String beforeEachLine,
String endLine,
String skipLinePattern,
String firstLineDetectionPattern,
String lastLineDetectionPattern,
boolean allowBlankLines,
boolean isMultiline)
Constructs a new HeaderDefinition object with every header definition properties. |
Method Summary | |
---|---|
boolean |
allowBlankLines()
|
boolean |
equals(Object o)
|
String |
getBeforeEachLine()
|
String |
getEndLine()
|
String |
getFirstLine()
|
protected Pattern |
getSkipLinePattern()
|
String |
getType()
|
int |
hashCode()
|
boolean |
isFirstHeaderLine(String line)
Tells if the given content line is the first line of a possible header of this definition kind. |
boolean |
isLastHeaderLine(String line)
Tells if the given content line is the last line of a possible header of this definition kind. |
boolean |
isMultiLine()
|
boolean |
isSkipLine(String line)
Tells if the given content line must be skipped according to this header definition. |
void |
setPropertyFromString(String property,
String value)
Sets header definition properties using its property name and its string value. If you want to set a property to null you must not call this function. This function is mainly used while parsing properties from the XML configuration file. |
String |
toString()
|
void |
validate()
Checks this header definition consistency, in other words if all the mandatory properties of the definition have been set. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HeaderDefinition(String type, String firstLine, String beforeEachLine, String endLine, String skipLinePattern, String firstLineDetectionPattern, String lastLineDetectionPattern, boolean allowBlankLines, boolean isMultiline)
HeaderDefinition
object with every header definition properties.
type
- The type name for this header definition.firstLine
- The string to output before the content of the first line of this header.beforeEachLine
- The string to output before the content of each line of this header (except
firstLine and endLine).endLine
- The string to output before the content of the last line of this header.skipLinePattern
- The pattern of lines to skip before being allowed to output this header or null
if it can be outputted from the line of the file.firstLineDetectionPattern
- The pattern to detect the first line of a previous header.lastLineDetectionPattern
- The pattern to detect the last line of a previous header.
IllegalArgumentException
- If the type name is null.public HeaderDefinition(String type)
HeaderDefinition
with only initializing the header type. You must then set all the
other definitions properties manually in order to have a coherent object.
type
- The type name for this header definition.
IllegalArgumentException
- If the type name is null.check(String, String)
,
setPropertyFromString(String, String)
Method Detail |
---|
public String getFirstLine()
public String getBeforeEachLine()
public String getEndLine()
public String getType()
public boolean allowBlankLines()
public boolean isSkipLine(String line)
line
- The line to test.
public boolean isFirstHeaderLine(String line)
line
- The line to test.
public boolean isLastHeaderLine(String line)
line
- The line to test.
protected Pattern getSkipLinePattern()
public void setPropertyFromString(String property, String value)
property
- The property name.value
- The property value.
IllegalArgumentException
- If the property value is null.public void validate()
IllegalStateException
- If a mandatory property has not been set.public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
public boolean isMultiLine()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |