Class 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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String destName
      Sets the destination filename in the outputDirectory.
      private java.lang.String fileMode
      Similar to a UNIX permission, sets the file mode of the files included.
      private boolean filtered
      Sets whether to determine if the file is filtered.
      private java.lang.String lineEnding
      Sets the line-endings of the files in this file.
      private java.lang.String outputDirectory
      Sets the output directory relative to the root of the root directory of the assembly.
      private java.lang.String source
      Sets the absolute or relative path from the module's directory of the file to be included in the assembly.
      private java.util.List<java.lang.String> sources
      Field sources.
    • Constructor Summary

      Constructors 
      Constructor Description
      FileItem()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addSource​(java.lang.String string)
      Method addSource.
      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 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.
      java.util.List<java.lang.String> getSources()
      Method getSources.
      boolean isFiltered()
      Get sets whether to determine if the file is filtered.
      void removeSource​(java.lang.String string)
      Method removeSource.
      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 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.
      void setSources​(java.util.List<java.lang.String> sources)
      Set set of absolute or relative paths from the module's directory of the files be combined and included in the assembly.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • source

        private java.lang.String source
        Sets the absolute or relative path from the module's directory of the file to be included in the assembly.
      • sources

        private java.util.List<java.lang.String> sources
        Field sources.
      • outputDirectory

        private java.lang.String outputDirectory
        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.
      • destName

        private java.lang.String destName
        Sets the destination filename in the outputDirectory. Default is the same name as the source's file.
      • fileMode

        private java.lang.String fileMode
        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)
      • lineEnding

        private java.lang.String lineEnding
        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
      • filtered

        private boolean filtered
        Sets whether to determine if the file is filtered.
    • Constructor Detail

      • FileItem

        public FileItem()
    • Method Detail

      • addSource

        public void addSource​(java.lang.String string)
        Method addSource.
        Parameters:
        string - a string object.
      • getDestName

        public java.lang.String getDestName()
        Get sets the destination filename in the outputDirectory. Default is the same name as the source's file.
        Returns:
        String
      • getFileMode

        public java.lang.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 java.lang.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 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.
        Returns:
        String
      • 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.
        Returns:
        String
      • getSources

        public java.util.List<java.lang.String> getSources()
        Method getSources.
        Returns:
        List
      • isFiltered

        public boolean isFiltered()
        Get sets whether to determine if the file is filtered.
        Returns:
        boolean
      • removeSource

        public void removeSource​(java.lang.String string)
        Method removeSource.
        Parameters:
        string - a string object.
      • 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 - a destName object.
      • setFileMode

        public void setFileMode​(java.lang.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 - a fileMode object.
      • setFiltered

        public void setFiltered​(boolean filtered)
        Set sets whether to determine if the file is filtered.
        Parameters:
        filtered - a filtered object.
      • setLineEnding

        public void setLineEnding​(java.lang.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 - a lineEnding object.
      • 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 - a outputDirectory object.
      • 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 - a source object.
      • setSources

        public void setSources​(java.util.List<java.lang.String> sources)
        Set set of absolute or relative paths from the module's directory of the files be combined and included in the assembly.
        Parameters:
        sources - a sources object.