Class HeaderDefinition
- java.lang.Object
-
- com.google.code.mojo.license.header.HeaderDefinition
-
public final class HeaderDefinition extends Object
TheHeaderDefinition
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.- Author:
- Cedric Pronzato
-
-
Constructor Summary
Constructors Constructor Description HeaderDefinition(String type)
Constructs a newHeaderDefinition
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 newHeaderDefinition
object with every header definition properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
Constructor Detail
-
HeaderDefinition
public HeaderDefinition(String type, String firstLine, String beforeEachLine, String endLine, String skipLinePattern, String firstLineDetectionPattern, String lastLineDetectionPattern, boolean allowBlankLines, boolean isMultiline)
Constructs a newHeaderDefinition
object with every header definition properties.- Parameters:
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.- Throws:
IllegalArgumentException
- If the type name is null.
-
HeaderDefinition
public HeaderDefinition(String type)
Constructs a newHeaderDefinition
with only initializing the header type. You must then set all the other definitions properties manually in order to have a coherent object.- Parameters:
type
- The type name for this header definition.- Throws:
IllegalArgumentException
- If the type name is null.- See Also:
check(String, String)
,setPropertyFromString(String, String)
-
-
Method Detail
-
getFirstLine
public String getFirstLine()
-
getBeforeEachLine
public String getBeforeEachLine()
-
getEndLine
public String getEndLine()
-
getType
public String getType()
-
allowBlankLines
public boolean allowBlankLines()
-
isSkipLine
public boolean isSkipLine(String line)
Tells if the given content line must be skipped according to this header definition. The header is outputted after any skipped line if any pattern defined on this point or on the first line if not pattern defined.- Parameters:
line
- The line to test.- Returns:
- true if this line must be skipped or false.
-
isFirstHeaderLine
public boolean isFirstHeaderLine(String line)
Tells if the given content line is the first line of a possible header of this definition kind.- Parameters:
line
- The line to test.- Returns:
- true if the first line of a header have been recognized or false.
-
isLastHeaderLine
public boolean isLastHeaderLine(String line)
Tells if the given content line is the last line of a possible header of this definition kind.- Parameters:
line
- The line to test.- Returns:
- true if the last line of a header have been recognized or false.
-
getSkipLinePattern
protected Pattern getSkipLinePattern()
-
setPropertyFromString
public 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.- Parameters:
property
- The property name.value
- The property value.- Throws:
IllegalArgumentException
- If the property value is null.
-
validate
public void validate()
Checks this header definition consistency, in other words if all the mandatory properties of the definition have been set.- Throws:
IllegalStateException
- If a mandatory property has not been set.
-
isMultiLine
public boolean isMultiLine()
-
-