Package de.funfried.netbeans.plugins.external.formatter.java.google

Class GoogleJavaFormatterService

java.lang.Object
de.funfried.netbeans.plugins.external.formatter.java.base.AbstractJavaFormatterService<de.funfried.netbeans.plugins.external.formatter.java.google.GoogleFormatJob>
de.funfried.netbeans.plugins.external.formatter.java.google.GoogleJavaFormatterService
All Implemented Interfaces:
FormatterService
public class GoogleJavaFormatterService extends AbstractJavaFormatterService<de.funfried.netbeans.plugins.external.formatter.java.google.GoogleFormatJob>
Google implementation of the AbstractJavaFormatterService.
Author:
bahlef

  • Field Details

  • Constructor Details

    • GoogleJavaFormatterService

      public GoogleJavaFormatterService()

  • Method Details

    • canHandle

      public boolean canHandle(Document document)
      Returns true if and only if this implementation would be able to format the given Document, otherwise false.
      Parameters:
      document - the Document to check
      Returns:
      true if and only if this implementation would be able to format the given Document, otherwise false

    • getDisplayName

      @NonNull public String getDisplayName()
      Retruns the display name of this formatter implementation.
      Returns:
      the display name of this formatter implementation

    • getId

      @NonNull public String getId()
      Retruns the unique identifier of this formatter implementation.
      Returns:
      the unique identifier of this formatter implementation

    • createOptionsPanel

      public FormatterOptionsPanel createOptionsPanel(Project project)
      Creates and returns the FormatterOptionsPanel for this formatter which will be displayed in the overall options dialog underneath this formatters selection.
      Parameters:
      project - the Project if the panel which is created is used to modify project specific settings, otherwise null
      Returns:
      the FormatterOptionsPanel for this formatter, or null if there are no options a user could make for this formatter

    • getContinuationIndentSize

      @CheckForNull public Integer getContinuationIndentSize(Document document)
      Returns the continuation indent size configured for the given Document, or null if it should not affect the editor behavior.
      Parameters:
      document - the Document for which the continuation indent size is requested
      Returns:
      the continuation indent size configured for the given Document, or null if it should not affect the editor behavior

    • getIndentSize

      @CheckForNull public Integer getIndentSize(Document document)
      Returns the indent size configured for the given Document, or null if it should not affect the editor behavior.
      Parameters:
      document - the Document for which the indent size is requested
      Returns:
      the indent size configured for the given Document, or null if it should not affect the editor behavior

    • getRightMargin

      @CheckForNull public Integer getRightMargin(Document document)
      Returns the right margin (position of the red line in the editor) configured for the given Document, or null if it should not affect the editor behavior.
      Parameters:
      document - the Document for which the right margin is requested
      Returns:
      the right margin (position of the red line in the editor) configured for the given Document, or null if it should not affect the editor behavior

    • getFormatJob

      protected de.funfried.netbeans.plugins.external.formatter.java.google.GoogleFormatJob getFormatJob(StyledDocument document, SortedSet<Pair<Integer,Integer>> changedElements)
      Returns the AbstractJavaFormatterService.
      Specified by:
      getFormatJob in class AbstractJavaFormatterService<de.funfried.netbeans.plugins.external.formatter.java.google.GoogleFormatJob>
      Parameters:
      document - the StyledDocument which should be formatted
      changedElements - a SortedSet containing ranges as Pair objects that should be formatted

    • getSpacesPerTab

      @CheckForNull public Integer getSpacesPerTab(Document document)
      Returns the spaces per tab configured for the given Document, or null if it should not affect the editor behavior.
      Parameters:
      document - the Document for which the spaces per tab is requested
      Returns:
      the spaces per tab configured for the given Document, or null if it should not affect the editor behavior

    • isExpandTabToSpaces

      @CheckForNull public Boolean isExpandTabToSpaces(Document document)
      Returns the expand tab to spaces flag configured for the given Document, or null if it should not affect the editor behavior.
      Parameters:
      document - the Document for which the expand tab to spaces flag is requested
      Returns:
      the expand tab to spaces flag configured for the given Document, or null if it should not affect the editor behavior

    • organizeImports

      @CheckForNull public Boolean organizeImports(StyledDocument document, boolean afterFixImports) throws BadLocationException
      Organizes the imports of the given StyledDocument.
      Parameters:
      document - the StyledDocument
      afterFixImports - true if this method was called after fixing imports, otherwise false
      Returns:
      true if the imports have been reorganized, if something went wrong it will return false, if it wasn't executed, e.g. because it is not activated through its configuration, it will return null
      Throws:
      BadLocationException - if something goes wrong while applying the reorganized imports code