Package org.apache.jackrabbit.vault.fs.io

Class DocViewFormat

java.lang.Object
org.apache.jackrabbit.vault.fs.io.DocViewFormat
public class DocViewFormat extends Object
This class provides access to the commonly used doc view xml format and functionality that checks files for the format or reformats them accordingly.

  • Constructor Details

    • DocViewFormat

      public DocViewFormat()

  • Method Details

    • getXmlOutputFormat

      public OutputFormat getXmlOutputFormat()
      Returns the OutputFormat used by DocViewSerializer when writing doc view xml files.
      Returns:
      the output format

    • format

      public boolean format(File file, boolean dryRun) throws IOException
      Formats a given file using the OutputFormat returned by getXmlOutputFormat(). The file is replaced on disk but only if wasn't already formatted correctly and if dryRun is false.
      Parameters:
      file - the file to format
      dryRun - If true, then the file is never replaced on disk.
      Returns:
      true if the formatted version differs from the original.
      Throws:
      IOException - if an I/O error occurs

    • format

      public List<String> format(File directory, List<Pattern> filenamePatterns, boolean dryRun) throws IOException
      Formats given files using the OutputFormat returned by getXmlOutputFormat() by traversing the directory tree given as file. Only those files will be formatted, that have a filename matching at least one of the given filenamePatterns, and only if dryRun is false.
      Parameters:
      directory - the start directory
      filenamePatterns - list of regexp patterns
      dryRun - If true, then the file is never replaced on disk.
      Returns:
      a list of relative paths of those files which are not formatted correctly according to format(File, boolean)
      Throws:
      IOException - in case there is an exception during traversal or formatting. That means formatting will fail on the first error that appeared