FileItem (Apache Maven Assembly Plugin 2.4.1 API)

java.lang.Object
- org.apache.maven.plugin.assembly.model.FileItem

All Implemented Interfaces:

Serializable
```
public class FileItem
extends Object
implements 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

Constructors
Constructor and Description

FileItem()

Constructors
Constructor and Description
`FileItem()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDestName()` Get sets the destination filename in the outputDirectory.
`String`	`getFileMode()` Get similar to a UNIX permission, sets the file mode of the files included.
`String`	`getLineEnding()` Get sets the line-endings of the files in this file.
`String`	`getOutputDirectory()` Get sets the output directory relative to the root of the root directory of the assembly.
`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(String destName)` Set sets the destination filename in the outputDirectory.
`void`	`setFileMode(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(String lineEnding)` Set sets the line-endings of the files in this file.
`void`	`setOutputDirectory(String outputDirectory)` Set sets the output directory relative to the root of the root directory of the assembly.
`void`	`setSource(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 String getDestName()
```
    Get sets the destination filename in the outputDirectory. Default is the same name as the source's file.
    
    Returns:
    String
  - getFileMode
```
public String getFileMode()
```
    Get similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
    
    Returns:
    String
  - getLineEnding
```
public String getLineEnding()
```
    Get sets the line-endings of the files in this file. Valid values are:
    - "keep" - Preserve all line endings
    - "unix" - Use Unix-style line endings
    - "lf" - Use a single line-feed line endings
    - "dos" - Use DOS-style line endings
    - "crlf" - Use Carraige-return, line-feed line endings
    Returns:
    String
  - getOutputDirectory
```
public 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.
    
    Returns:
    String
  - getSource
```
public String getSource()
```
    Get sets the absolute or relative path from the module's directory of the file to be included in the assembly.
    
    Returns:
    String
  - isFiltered
```
public boolean isFiltered()
```
    Get sets whether to determine if the file is filtered.
    
    Returns:
    boolean
  - setDestName
```
public void setDestName(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(String fileMode)
```
    Set similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 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(String lineEnding)
```
    Set sets the line-endings of the files in this file. Valid values are:
    - "keep" - Preserve all line endings
    - "unix" - Use Unix-style line endings
    - "lf" - Use a single line-feed line endings
    - "dos" - Use DOS-style line endings
    - "crlf" - Use Carraige-return, line-feed line endings
    Parameters:
    lineEnding -
  - setOutputDirectory
```
public void setOutputDirectory(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(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 -

Class FileItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileItem

Method Detail

getDestName

getFileMode

getLineEnding

getOutputDirectory

getSource

isFiltered

setDestName

setFileMode

setFiltered

setLineEnding

setOutputDirectory

setSource