org.editorconfig.core

Class EditorConfig

java.lang.Object

org.editorconfig.core.EditorConfig

public class EditorConfig
extends Object

EditorConfig handler

Author:

Dennis.Ushakov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditorConfig.OutPair String-String pair to store the parsing result.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
EditorConfig() Creates EditorConfig handler with default configuration filename (.editorconfig) and version VERSION
EditorConfig(String configFilename, String version) Creates EditorConfig handler with specified configuration filename and version.

Method Summary

Methods

Modifier and Type	Method and Description
List<EditorConfig.OutPair>	getProperties(String filePath) Parse editorconfig files corresponding to the file path given by filename, and return the parsing result.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static String VERSION

Constructor Detail

EditorConfig

public EditorConfig()

Creates EditorConfig handler with default configuration filename (.editorconfig) and version VERSION

EditorConfig

public EditorConfig(String configFilename,
            String version)

Creates EditorConfig handler with specified configuration filename and version. Used mostly for debugging/testing.

Parameters:

configFilename - configuration file name to be searched for instead of .editorconfig

version - required version

Method Detail

getProperties

public List<EditorConfig.OutPair> getProperties(String filePath)
                                         throws EditorConfigException

Parse editorconfig files corresponding to the file path given by filename, and return the parsing result.

Parameters:

filePath - The full path to be parsed. The path is usually the path of the file which is currently edited by the editor.

Returns:

The parsing result stored in a list of EditorConfig.OutPair.

Throws:

ParsingException - If an .editorconfig file could not be parsed

VersionException - If version greater than actual is specified in constructor

EditorConfigException - If an EditorConfig exception occurs. Usually one of ParsingException or VersionException