Skip to content

Commit

Permalink
#16: Release 2.0.0
Browse files Browse the repository at this point in the history
- Fix remaining JavaDoc issues
- Update README with releases
  • Loading branch information
martin-fleck-at committed Dec 10, 2021
1 parent 6c5674b commit 97f731f
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The nightly builds are available as maven repository or p2 update site.
### Maven [![m2-deploy-status](https://img.shields.io/jenkins/build?jobUrl=https://ci.eclipse.org/emfcloud/job/deploy-emfcloud-emfjson-jackson-m2&label=m2-publish)](https://ci.eclipse.org/emfcloud/job/deploy-emfcloud-emfjson-jackson-m2/)

- <i>Snapshots: </i> https://oss.sonatype.org/content/repositories/snapshots/org/eclipse/emfcloud/emfjson-jackson/
- <i>Releases/Release Candidates: </i> There are no releases available yet
- <i>Releases/Release Candidates: </i> https://oss.sonatype.org/content/repositories/releases/org/eclipse/emfcloud/emfjson-jackson/

To use the Maven artifact add the following dependency to your POM file:

Expand Down Expand Up @@ -64,7 +64,7 @@ If you want to consume the nightly builds you have to configure the sonatype sna
### P2 Update Site [![p2-deploy-status](https://img.shields.io/jenkins/build?jobUrl=https://ci.eclipse.org/emfcloud/job/deploy-emfcloud-emfjson-jackson-p2&label=p2-publish)](https://ci.eclipse.org/emfcloud/job/deploy-emfcloud-emfjson-jackson-p2/)

- Snapshots: https://download.eclipse.org/emfcloud/emfjson-jackson/p2/nightly/
- Releases/Release Candidates: There are no releases available yet
- Releases/Release Candidates: https://download.eclipse.org/emfcloud/emfjson-jackson/p2/releases/

This update sites contain the bundle and feature for emfjson-jackson and Jackson.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private JsonAnnotations() {
/**
* Returns the name that should be use to serialize the property.
*
* @param element
* @param element any element
* @return name of property
*/
public static String getElementName(final ENamedElement element) {
Expand All @@ -62,7 +62,7 @@ public static List<String> getAliases(final ENamedElement element) {
/**
* Returns true if the feature should not be serialize.
*
* @param feature
* @param feature any feature
* @return true if should not be serialize
*/
public static boolean shouldIgnore(final EStructuralFeature feature) {
Expand All @@ -72,7 +72,7 @@ public static boolean shouldIgnore(final EStructuralFeature feature) {
/**
* Returns the property that should be use to store the type information of the classifier.
*
* @param classifier
* @param classifier any classifier
* @return the type information property
*/
@SuppressWarnings("checkstyle:cyclomaticComplexity")
Expand Down Expand Up @@ -119,7 +119,7 @@ public static EcoreTypeInfo getTypeProperty(final EClassifier classifier) {
* Returns true if the classifier type information should not be serialize.
* This is true when the classifier possesses an annotation @JsonType with include = "false".
*
* @param classifier
* @param classifier any classifier
* @return true if type info should not be serialize
*/
public static boolean shouldIgnoreType(final EClassifier classifier) {
Expand All @@ -131,7 +131,7 @@ public static boolean shouldIgnoreType(final EClassifier classifier) {
/**
* Returns the property that should be use to serialize the identity of the object.
*
* @param classifier
* @param classifier any classifier
* @return the identity property
*/
public static String getIdentityProperty(final EClassifier classifier) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ public interface URIHandler {
/**
* Returns the URI {@link URI#resolve(URI) resolved} against the base URI.
*
* @param uri the URI to resolve.
* @param baseURI the base URI against which the URI is resolved.
* @param uri the URI to resolve.
* @return the URI resolved against the base URI.
* @see URI#resolve(URI)
*/
Expand All @@ -30,7 +31,8 @@ public interface URIHandler {
/**
* Returns the URI {@link URI#deresolve(URI) deresolved} against the base URI.
*
* @param uri the URI to resolve.
* @param baseURI the base URI against which the URI is deresolved.
* @param uri the URI to resolve.
* @return the URI resolved against the base URI.
* @see URI#deresolve(URI)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ public static ObjectMapper setupDefaultMapper() {
* Returns a pre configured mapper using the EMF module and the specified jackson factory.
* This method can be used to work with formats others than JSON (such as YAML).
*
* @param factory
* @param factory Jackson factory
* @return mapper
*/
public static ObjectMapper setupDefaultMapper(final JsonFactory factory) {
Expand Down
13 changes: 7 additions & 6 deletions src/main/java/org/eclipse/emfcloud/jackson/utils/EObjects.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ private EObjects() {}
* Set or add a value to an object reference. The value must be
* an EObject.
*
* @param owner
* @param reference
* @param value
* @param owner EObject owning the reference
* @param reference the reference of the value to set
* @param value value to set for the reference
*/
public static void setOrAdd(final EObject owner, final EReference reference, final Object value) {
if (value != null) {
Expand All @@ -56,8 +56,9 @@ public static void setOrAdd(final EObject owner, final EReference reference, fin
* Checks that the contained object is in a different resource than it's owner, making
* it a contained proxy.
*
* @param owner
* @param contained
* @param ctxt the databind context
* @param owner EObject owning the contained object
* @param contained contained object to be evaluated
* @return true if proxy
*/
public static boolean isContainmentProxy(final DatabindContext ctxt, final EObject owner, final EObject contained) {
Expand All @@ -76,9 +77,9 @@ public static boolean isContainmentProxy(final DatabindContext ctxt, final EObje
*
* @param key of entry
* @param value of entry
* @param type of entry
* @return entry
*/

public static EObject createEntry(final String key, final Object value, final EClass type) {
if (type == EcorePackage.Literals.ESTRING_TO_STRING_MAP_ENTRY) {

Expand Down

0 comments on commit 97f731f

Please sign in to comment.