https://github.com/editorconfig/editorconfig-core-java-binding

EditorConfig Core Java Binding
https://github.com/editorconfig/editorconfig-core-java-binding

Last synced: about 1 month ago
JSON representation

EditorConfig Core Java Binding

• Host: GitHub
• URL: https://github.com/editorconfig/editorconfig-core-java-binding
• Owner: editorconfig
• License: other
• Created: 2013-04-14T18:35:53.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-06-12T05:20:25.000Z (over 2 years ago)
• Last Synced: 2024-06-14T00:21:04.745Z (6 months ago)
• Language: Java
• Homepage: http://editorconfig.org
• Size: 148 KB
• Stars: 8
• Watchers: 5
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# EditorConfig Java Binding

This directory is for [EditorConfig][] Core Java Binding. This binding is a

Java binding for [EditorConfig Python Core][], made possible by [Jython][].

**NOTE:** This java binding has been obsoleted. Please use

[EditorConfig Java Core][] instead.

## EditorConfig Project

EditorConfig makes it easy to maintain the correct coding style when switching

between different text editors and between different projects.  The

EditorConfig project maintains a file format and plugins for various text

editors which allow this file format to be read and used by those editors.  For

information on the file format and supported text editors, see the

[EditorConfig website][EditorConfig].

## Build the Library and Generate the Doc

First be sure that the submodule is initialized:

    cd /path/to/editorconfig-core-java-binding

    git submodule init

    git submodule update

With [Ant][]:

    ant && ant doc

The built jar file is in the `build` directory and the documentation is in the

`doc` directory.

## Use as a Library

A basic example:

```java

EditorConfig ec = new EditorConfig();

List l = null;

try {

    l = ec.getProperties("/home/user/src/editorconfig-core-py/a.py");

} catch(EditorConfigException e) {

    System.out.println(e);

    System.exit(1);

}

for(int i = 0; i < l.size(); ++i) {

    System.out.println(l.get(i).getKey() + "=" + l.get(i).getVal());

}

```

A more complex example is in the `example` directory. There is an

[online documentation][] for API details, or you could run `ant doc` to

generate html documentation. The generated documentation will locate in `doc`

directory.

## License

All source files of the Java binding are distributed under the PSF license. See

LICENSE.txt for details.

Copyright (C) 2012-2013, EditorConfig Team

[Ant]: http://ant.apache.org

[EditorConfig Java Core]: https://github.com/editorconfig/editorconfig-core-java

[EditorConfig Python Core]: https://github.com/editorconfig/editorconfig-core-py

[EditorConfig]: http://editorconfig.org

[Jython]: http://www.jython.org

[online documentation]: http://javadocs.editorconfig.org