Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gastaldi/myaddon
https://github.com/gastaldi/myaddon
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gastaldi/myaddon
- Owner: gastaldi
- Created: 2014-04-04T02:26:35.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-04-29T17:16:51.000Z (over 10 years ago)
- Last Synced: 2023-03-11T22:42:16.393Z (over 1 year ago)
- Language: Java
- Size: 156 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.asciidoc
Awesome Lists containing this project
README
== myaddon
:idprefix: id_
(choose one, do not modify, then add a second sentence with a brief description, starting with - "The myaddon addon enables blah blah...)
This addon provides *standalone* functionality, and *exports services* for use in other addons.
This addon provides *standalone* functionality.
This addon *exports services* for use in other addons.
This addon *provides classes* for use in other addons.
This addon is a 'Furnace container' that provides *lifecycle* and *service registry* support for dependent addons.
=== Dependencies: None (or)
=== Depends on
[options="header"]
|===
|Addon |Exported |Optional
|DEP1
|yes
|no
|DEP2
|yes
|yes
|===
== 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:
(Make sure the dependency is put all the way to the left, and uses 3 spaces for indentation of GAV)
[source,xml]
----
org.myaddon
myaddon
forge-addon
${version}
----
== Features
ABCFactory for simple ABC blah::
Allows for blah blah
+
[source,java]
----
@Inject private ABCFactory factory;
ABC abc = factory.createABC();
----
+
[TIP]
====
If your addon uses a container that does not support "@Inject" annotations, services such as the `ABCFactory` may also be
accessed via the `AddonRegistry`:
----
Imported imported = addonRegistry.getServices(ABCFactory.class);
ABCFactory factory = imported.get();
----
====
Creating a new XYZ instance::
Causes XYZ to occur
+
[source,java]
----
XYZ xyz = factory.createXYZ();
----