org.codehaus.mojo.license.header.transformer
Class XmlFileHeaderTransformer

java.lang.Object
  extended by org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer
      extended by org.codehaus.mojo.license.header.transformer.XmlFileHeaderTransformer
All Implemented Interfaces:
FileHeaderTransformer

public class XmlFileHeaderTransformer
extends AbstractFileHeaderTransformer

Implementation of FileHeaderTransformer for xml format.

Since:
1.0
Author:
tchemit

Field Summary
static String COMMENT_END_TAG
           
static String COMMENT_LINE_PREFIX
           
static String COMMENT_START_TAG
           
static String DESCRIPTION
           
static String NAME
           
 
Fields inherited from class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer
commentEndTag, commentLinePrefix, commentStartTag, COPYRIGHT_PATTERN, description, name, processEndTag, processStartTag, REMOVE_SPACE_PATTERN, sectionDelimiter
 
Fields inherited from interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer
DEFAULT_PROCESS_END_TAG, DEFAULT_PROCESS_START_TAG, DEFAULT_SECTION_DELIMITER, LINE_SEPARATOR, ROLE_NAME
 
Constructor Summary
XmlFileHeaderTransformer()
           
 
Method Summary
 String addHeader(String header, String content)
          Adds the header.
 String[] getDefaultAcceptedExtensions()
          Get the default accepted extensions for this transformer.
 
Methods inherited from class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer
boxComment, boxProcessTag, getCommentEndTag, getCommentLinePrefix, getCommentStartTag, getDescription, getName, getProcessEndTag, getProcessStartTag, getSectionDelimiter, isCopyrightEquals, isDescriptionEquals, isLicenseEquals, removeSpaces, setCommentEndTag, setCommentLinePrefix, setCommentStartTag, setDescription, setName, setProcessEndTag, setProcessStartTag, setSectionDelimiter, toFileHeader, toHeaderContent, toString, unboxComent, unboxProcessTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
See Also:
Constant Field Values

COMMENT_LINE_PREFIX

public static final String COMMENT_LINE_PREFIX
See Also:
Constant Field Values

COMMENT_START_TAG

public static final String COMMENT_START_TAG
See Also:
Constant Field Values

COMMENT_END_TAG

public static final String COMMENT_END_TAG
See Also:
Constant Field Values
Constructor Detail

XmlFileHeaderTransformer

public XmlFileHeaderTransformer()
Method Detail

getDefaultAcceptedExtensions

public String[] getDefaultAcceptedExtensions()
Description copied from interface: FileHeaderTransformer
Get the default accepted extensions for this transformer.

Returns:
the default accepted extensions.

addHeader

public String addHeader(String header,
                        String content)
Description copied from interface: FileHeaderTransformer
Adds the header.

Specified by:
addHeader in interface FileHeaderTransformer
Overrides:
addHeader in class AbstractFileHeaderTransformer
Parameters:
header - header to add
content - content of original file
Returns:
the new full file content beginning with header


Copyright © 2010-2012 The Kuali Foundation. All Rights Reserved.