Class TemplateDescriptor
java.lang.Object
org.apache.maven.archetype.old.descriptor.TemplateDescriptor
public class TemplateDescriptor
extends java.lang.Object
Contains the attributes of an archetype's template (either a source or resource file).
The attributes indicate if the template should be filtered and it's encoding.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance ofTemplateDescriptor
that should be filtered and has the default encoding. -
Method Summary
Modifier and TypeMethodDescriptionprivate static java.lang.String
Returns the canonical name of the default character encoding of this Java virtual machine.java.lang.String
Returns the name of the encoding of the template file (e.g.boolean
Returnstrue
if the template should be filtered andfalse
otherwise.void
setEncoding
(java.lang.String encoding) Sets the name of the encoding of the template file.void
setFiltered
(boolean filtered) Defines whether the template should be filtered (processed by Velocity) or not.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
filtered
private boolean filteredDetermines if the template should be filtered or not. -
encoding
private java.lang.String encodingDetermines the template's encoding.
-
-
Constructor Details
-
TemplateDescriptor
public TemplateDescriptor()Creates a new instance ofTemplateDescriptor
that should be filtered and has the default encoding.
-
-
Method Details
-
getDefaultEncoding
private static java.lang.String getDefaultEncoding()Returns the canonical name of the default character encoding of this Java virtual machine.- Returns:
- the name of the default character encoding.
-
isFiltered
public boolean isFiltered()Returnstrue
if the template should be filtered andfalse
otherwise.- Returns:
true
if the template should be filtered andfalse
otherwise.
-
setFiltered
public void setFiltered(boolean filtered) Defines whether the template should be filtered (processed by Velocity) or not.- Parameters:
filtered
-true
if it should be processed by Velocity andfales
otherwise.
-
getEncoding
public java.lang.String getEncoding()Returns the name of the encoding of the template file (e.g.us-ascci
,utf-8
,iso-8859-1
).- Returns:
- the name of the encoding of the template file.
-
setEncoding
public void setEncoding(java.lang.String encoding) throws java.nio.charset.IllegalCharsetNameException, java.nio.charset.UnsupportedCharsetException Sets the name of the encoding of the template file.- Parameters:
encoding
- New value of property encoding.- Throws:
java.nio.charset.IllegalCharsetNameException
- if the given charset name is illegaljava.nio.charset.UnsupportedCharsetException
- if no support for the named encoding is available in this instance of the Java virtual machine
-