org.apache.maven.plugin.assembly.model
Class FileItem

java.lang.Object
  extended by org.apache.maven.plugin.assembly.model.FileItem
All Implemented Interfaces:
java.io.Serializable

public class FileItem
extends java.lang.Object
implements java.io.Serializable

A file allows individual file inclusion with the option to change the destination filename not supported by fileSets.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
FileItem()
           
 
Method Summary
 java.lang.String getDestName()
          Get Sets the destination filename in the outputDirectory.
 java.lang.String getFileMode()
          Get Similar to a UNIX permission, sets the file mode of the files included.
 java.lang.String getLineEnding()
          Get Sets the line-endings of the files in this file.
 java.lang.String getModelEncoding()
           
 java.lang.String getOutputDirectory()
          Get Sets the output directory relative to the root of the root directory of the assembly.
 java.lang.String getSource()
          Get Sets the absolute or relative path from the module's directory of the file to be included in the assembly.
 boolean isFiltered()
          Get Sets whether to determine if the file is filtered.
 void setDestName(java.lang.String destName)
          Set Sets the destination filename in the outputDirectory.
 void setFileMode(java.lang.String fileMode)
          Set Similar to a UNIX permission, sets the file mode of the files included.
 void setFiltered(boolean filtered)
          Set Sets whether to determine if the file is filtered.
 void setLineEnding(java.lang.String lineEnding)
          Set Sets the line-endings of the files in this file.
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setOutputDirectory(java.lang.String outputDirectory)
          Set Sets the output directory relative to the root of the root directory of the assembly.
 void setSource(java.lang.String source)
          Set Sets the absolute or relative path from the module's directory of the file to be included in the assembly.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileItem

public FileItem()
Method Detail

getDestName

public java.lang.String getDestName()
Get Sets the destination filename in the outputDirectory. Default is the same name as the source's file.


getFileMode

public java.lang.String getFileMode()
Get Similar to a UNIX permission, sets the file mode of the files included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)


getLineEnding

public java.lang.String getLineEnding()
Get Sets the line-endings of the files in this file. Valid values are:


getOutputDirectory

public java.lang.String getOutputDirectory()
Get Sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.


getSource

public java.lang.String getSource()
Get Sets the absolute or relative path from the module's directory of the file to be included in the assembly.


isFiltered

public boolean isFiltered()
Get Sets whether to determine if the file is filtered.


setDestName

public void setDestName(java.lang.String destName)
Set Sets the destination filename in the outputDirectory. Default is the same name as the source's file.

Parameters:
destName -

setFileMode

public void setFileMode(java.lang.String fileMode)
Set Similar to a UNIX permission, sets the file mode of the files included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Parameters:
fileMode -

setFiltered

public void setFiltered(boolean filtered)
Set Sets whether to determine if the file is filtered.

Parameters:
filtered -

setLineEnding

public void setLineEnding(java.lang.String lineEnding)
Set Sets the line-endings of the files in this file. Valid values are:

Parameters:
lineEnding -

setOutputDirectory

public void setOutputDirectory(java.lang.String outputDirectory)
Set Sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.

Parameters:
outputDirectory -

setSource

public void setSource(java.lang.String source)
Set Sets the absolute or relative path from the module's directory of the file to be included in the assembly.

Parameters:
source -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.