Class 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 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. The default value is 0644. (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. The default value is 0644. (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 -