Skip to content

Commit

Permalink
Added parser-java README
Browse files Browse the repository at this point in the history
  • Loading branch information
gastaldi committed Jul 30, 2013
1 parent 86ed553 commit 991e501
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 8 deletions.
74 changes: 74 additions & 0 deletions parser-java/README.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
== parser-java
:idprefix: id_

This addon provides *standalone* functionality, and *exports services* for use in other addons.

=== Depends on

[options="header"]
|===
|Addon |Exported |Optional

|resources
|no
|yes


|projects
|no
|yes

|ui-spi
|no
|yes

|org.jboss.forge.furnace:container-cdi
|no
|no

|===

== Setup

This Addon requires the following installation steps.

=== Add configuration to pom.xml

To use this addon, you must add it as a dependency in the *pom.xml* of your `forge-addon` classified artifact:

[source,xml]
----
<dependency>
<groupId>org.jboss.forge.addon</groupId>
<artifactId>parser-java</artifactId>
<classifier>forge-addon</classifier>
<version>${version}</version>
</dependency>
----

== Features

Injecting JavaSourceFactory:: Allows creation and parsing of Java sources

[source,java]
----
@Inject
JavaSourceFactory factory;
JavaClass myClass = factory.parse(JavaClass.class, "public class MyClass{}");
----

Facets addon integration:: Read and persist java sources easily in your project

[source,java]
----
Project project = ...
JavaSourceFacet facet = project.getFacet(JavaSourceFacet.class);
...
----

Resources addon integration:: Custom resources for dealing with java types, methods and fields

ui-spi integration:: Registers the _InputType.JAVA_CLASS_PICKER_ for UIInput<JavaResource> injections
16 changes: 8 additions & 8 deletions ui/README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ There are basically four input types:
|Addon |Exported |Optional

|org.jboss.forge.furnace:container-cdi
|No
|No
|no
|no

|convert
|Yes
|No
|yes
|no


|facets
|Yes
|Yes
|yes
|yes


|ui-spi
|Yes
|Yes
|yes
|yes

|===

Expand Down

0 comments on commit 991e501

Please sign in to comment.