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

Class AbstractXmlFormatterService

java.lang.Object

de.funfried.netbeans.plugins.external.formatter.xml.base.AbstractXmlFormatterService

All Implemented Interfaces:

FormatterService

Direct Known Subclasses:

JsoupXmlFormatterService, RevelcXmlFormatterService

public abstract class AbstractXmlFormatterService
extends Object
implements FormatterService

Abstract base implementation of FormatterService for XML formatters.

Author:

bahlef

Constructor Summary

Constructors

Constructor	Description
AbstractXmlFormatterService()

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 FormatJob	getFormatJob(StyledDocument document)	Returns the FormatJob.
List<MimeType>	getSupportedMimeTypes()	Returns a List of supported MimeTypes for this FormatterService.
Boolean	organizeImports(StyledDocument document, boolean afterFixImports)	Organizes the imports of the given StyledDocument.

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

Constructor Details

AbstractXmlFormatterService

public AbstractXmlFormatterService()

Method Details

getFormatJob

protected abstract FormatJob getFormatJob(StyledDocument document)

Returns the FormatJob.

Parameters:

document - the StyledDocument which 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

organizeImports

@CheckForNull
public Boolean organizeImports(StyledDocument document,
 boolean afterFixImports)
                        throws BadLocationException

Organizes the imports of the given StyledDocument.

Specified by:

organizeImports in interface FormatterService

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