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

Class AbstractJavaFormatterService<F extends FormatJob>

java.lang.Object

de.funfried.netbeans.plugins.external.formatter.java.base.AbstractJavaFormatterService<F>

Type Parameters:

F - the FormatJob type

All Implemented Interfaces:

FormatterService

Direct Known Subclasses:

EclipseJavaFormatterService, GoogleJavaFormatterService, PalantirJavaFormatterService, SpringJavaFormatterService

public abstract class AbstractJavaFormatterService<F extends FormatJob>
extends Object
implements FormatterService

Abstract base implementation of FormatterService for Java formatters.

Author:

bahlef

Constructor Summary

Constructors

Constructor	Description
AbstractJavaFormatterService()

Method Summary

Modifier and Type	Method	Description
boolean	format(StyledDocument document, SortedSet<Pair<Integer,Integer>> changedElements)	Formats the given StyledDocument in regard to the given changedElements.
protected abstract F	getFormatJob(StyledDocument document, SortedSet<Pair<Integer,Integer>> changedElements)	Returns the AbstractJavaFormatterService.
List<MimeType>	getSupportedMimeTypes()	Returns a List of supported MimeTypes for this FormatterService.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.funfried.netbeans.plugins.external.formatter.FormatterService

canHandle, createOptionsPanel, getContinuationIndentSize, getDisplayName, getId, getIndentSize, getRightMargin, getSpacesPerTab, isExpandTabToSpaces, organizeImports

Constructor Details

AbstractJavaFormatterService

public AbstractJavaFormatterService()

Method Details

getFormatJob

protected abstract F getFormatJob(StyledDocument document,
 SortedSet<Pair<Integer,Integer>> changedElements)

Returns the AbstractJavaFormatterService.

Parameters:

document - the StyledDocument which should be formatted

changedElements - a SortedSet containing ranges as Pair objects that should be formatted

format

public boolean format(StyledDocument document,
 SortedSet<Pair<Integer,Integer>> changedElements)
               throws BadLocationException,
FormattingFailedException

Formats the given StyledDocument in regard to the given changedElements.

Specified by:

format in interface FormatterService

Parameters:

document - the StyledDocument which should be formatted

changedElements - a SortedSet containing ranges as Pair objects that should be formatted

Returns:

if true formatting was done, otherwise formatting was rejected and needs to be done by NetBeans internal formatter

Throws:

BadLocationException - if something goes wrong while applying the formatted code

FormattingFailedException - if the given StyledDocument cannot be formatted by the given formatter

getSupportedMimeTypes

public List<MimeType> getSupportedMimeTypes()

Returns a List of supported MimeTypes for this FormatterService.

Specified by:

getSupportedMimeTypes in interface FormatterService

Returns:

a List of supported MimeTypes for this FormatterService