Package com.microej.kf.util.control.fs

Class WriteFile

  • public class WriteFile
extends AbstractFile
    Action performed when writing to a file.

    • Field Summary

    • Constructor Summary

      Constructors 
      Constructor Description
      WriteFile​(java.io.File file, int nbWriteBytes)
      Creates a write file action.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getNbBytes()
      Gets the number of bytes to write.
      void onEnd​(boolean endWithSuccess)
      Called when the execution of the action is finished.
      void onStart()
      Called when the execution of the action is about to start.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WriteFile

        public WriteFile​(java.io.File file,
                 int nbWriteBytes)
        Creates a write file action.
        Parameters:
        file - the file to write.
        nbWriteBytes - the number of bytes to write.

    • Method Detail

      • getNbBytes

        public int getNbBytes()
        Gets the number of bytes to write.
        Returns:
        the number of bytes to write.

      • onStart

        public void onStart()
             throws java.lang.SecurityException
        Called when the execution of the action is about to start. This hook is used to check if the action is allowed to be performed.
        Throws:
        java.lang.SecurityException - if the action is not allowed to be performed.

      • onEnd

        public void onEnd​(boolean endWithSuccess)
        Called when the execution of the action is finished. This hook is used to update the current resources state of the module that performs the action.
        Parameters:
        endWithSuccess - true if the execution of the action was ended with success; false otherwise.