Class FileAppender<E>

    • Field Detail

      • COLLISION_WITH_EARLIER_APPENDER_URL

        protected static java.lang.String COLLISION_WITH_EARLIER_APPENDER_URL
      • append

        protected boolean append
        Append to or truncate the file? The default value for this variable is true, meaning that by default a FileAppender will append to an existing file and not truncate it.
      • fileName

        protected java.lang.String fileName
        The name of the active log file.
    • Constructor Detail

      • FileAppender

        public FileAppender()
    • Method Detail

      • setFile

        public void setFile​(java.lang.String file)
        The File property takes a string value which should be the name of the file to append to.
      • isAppend

        public boolean isAppend()
        Returns the value of the Append property.
      • rawFileProperty

        public final java.lang.String rawFileProperty()
        This method is used by derived classes to obtain the raw file property. Regular users should not be calling this method.
        Returns:
        the value of the file property
      • getFile

        public java.lang.String getFile()
        Returns the value of the File property.

        This method may be overridden by derived classes.

      • checkForFileCollisionInPreviousFileAppenders

        protected boolean checkForFileCollisionInPreviousFileAppenders()
      • addErrorForCollision

        protected void addErrorForCollision​(java.lang.String optionName,
                                            java.lang.String optionValue,
                                            java.lang.String appenderName)
      • openFile

        public void openFile​(java.lang.String file_name)
                      throws java.io.IOException

        Sets and opens the file where the log output will go. The specified file must be writable.

        If there was already an opened file, then the previous file is closed first.

        Do not use this method directly. To configure a FileAppender or one of its subclasses, set its properties one by one and then call start().

        Parameters:
        file_name - The path to the log file.
        Throws:
        java.io.IOException
      • isPrudent

        public boolean isPrudent()
        Returns:
        true if in prudent mode
        See Also:
        setPrudent(boolean)
      • setPrudent

        public void setPrudent​(boolean prudent)
        When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.
        Parameters:
        prudent -
      • setAppend

        public void setAppend​(boolean append)
      • setBufferSize

        public void setBufferSize​(FileSize bufferSize)
      • writeOut

        protected void writeOut​(E event)
                         throws java.io.IOException
        Overrides:
        writeOut in class OutputStreamAppender<E>
        Throws:
        java.io.IOException