Class FormatPreferences

java.lang.Object
org.jboss.jdeparser.FormatPreferences

public final class FormatPreferences extends Object
Formatter preferences.
Author:
David M. Lloyd
  • Constructor Details

    • FormatPreferences

      public FormatPreferences()
      Construct a new instance using default values.
    • FormatPreferences

      public FormatPreferences(Properties properties)
      Construct a new instance, mapping the given properties to the formatter configurations.
      Parameters:
      properties - the properties to map
    • FormatPreferences

      public FormatPreferences(ClassLoader classLoader) throws IOException
      Construct a new instance using a properties file loaded from the given class loader.
      Parameters:
      classLoader - the class loader
      Throws:
      IOException - if an error occurs while reading the properties
    • FormatPreferences

      public FormatPreferences(Filer filer, String name) throws IOException
      Construct a new instance using a properties file loaded from the given annotation processing filer.
      Parameters:
      filer - the filer to read from
      name - the name of the properties file to read
      Throws:
      IOException - if an error occurs while reading the properties
    • FormatPreferences

      public FormatPreferences(Filer filer) throws IOException
      Construct a new instance using a properties file loaded from the given annotation processing filer.
      Parameters:
      filer - the filer to read from
      Throws:
      IOException - if an error occurs while reading the properties
    • FormatPreferences

      public FormatPreferences(File file) throws IOException
      Construct a new instance using a properties file loaded from the given file name.
      Parameters:
      file - the name of the properties file to read
      Throws:
      IOException - if an error occurs while reading the properties
    • FormatPreferences

      public FormatPreferences(InputStream inputStream) throws IOException
      Construct a new instance using a properties read from the given stream.
      Parameters:
      inputStream - the stream to read properties from
      Throws:
      IOException - if an error occurs while reading the properties
    • FormatPreferences

      public FormatPreferences(Reader reader) throws IOException
      Construct a new instance using a properties read from the given stream.
      Parameters:
      reader - the stream to read properties from
      Throws:
      IOException - if an error occurs while reading the properties
  • Method Details

    • getLineLength

      public int getLineLength()
      Get the configured line length.
      Returns:
      the configured line length
    • getIndent

      public int getIndent(FormatPreferences.Indentation indentation)
      Get the configured indentation for the given context.
      Parameters:
      indentation - the indentation context
      Returns:
      the indentation
    • setIndent

      public int setIndent(FormatPreferences.Indentation indentation, int value)
      Set the configured indentation for the given context.
      Parameters:
      indentation - the indentation context
      value - the indentation
      Returns:
      the previous indentation
    • isIndentAbsolute

      public boolean isIndentAbsolute(FormatPreferences.Indentation indentation)
      Determine whether the indentation for the given context is absolute or relative.
      Parameters:
      indentation - the indentation context
      Returns:
      true if absolute, false if relative
    • setIndentAbsolute

      public void setIndentAbsolute(FormatPreferences.Indentation indentation)
      Set absolute indentation for the given context.
      Parameters:
      indentation - the indentation context
    • clearIndentAbsolute

      public void clearIndentAbsolute(FormatPreferences.Indentation indentation)
      Clear absolute indentation for the given context.
      Parameters:
      indentation - the indentation context
    • setSpaceType

      Set the spacing type for the given space context.
      Parameters:
      space - the space context
      spaceType - the space type
      Returns:
      the previous space type
    • setAllSpaceTypes

      public void setAllSpaceTypes(FormatPreferences.SpaceType toType, FormatPreferences.Space... spaces)
      Set several space contexts to the same spacing type.
      Parameters:
      toType - the type to set to
      spaces - the space contexts
    • getSpaceType

      Get the spacing type for a given space context.
      Parameters:
      space - the space context
      Returns:
      the spacing type
    • getWrapMode

      Get the wrapping mode for the given wrapping context.
      Parameters:
      wrapping - the wrapping context
      Returns:
      the current wrapping mode
    • setWrapMode

      Set the wrapping mode for the given wrapping context.
      Parameters:
      wrapping - the wrapping context
      mode - the wrapping mode
      Returns:
      the previous wrapping mode
    • addOption

      public void addOption(FormatPreferences.Opt... opts)
      Add option flags to these preferences.
      Parameters:
      opts - the flags to add
    • removeOption

      public void removeOption(FormatPreferences.Opt... opts)
      Remove option flags from these preferences.
      Parameters:
      opts - the flags to remove
    • hasOption

      public boolean hasOption(FormatPreferences.Opt opt)
      Determine whether the given option flag is set on these preferences.
      Parameters:
      opt - the flag to check
      Returns:
      true if the flag is present, false if it is absent