Improved: refactor javadocs in OFBiz to be standards compliant

(OFBIZ-9144)

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/trunk@1774815 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Brohl
2016-12-17 23:34:51 +00:00
parent 5a3c73fc2f
commit 97ba34128e
28 changed files with 84 additions and 96 deletions
@@ -503,11 +503,10 @@ public interface Delegator {
ModelEntity getModelEntity(String entityName);
/**
* Gets a Map of entity name & entity model pairs that are in the named
* Gets a Map of entity name and entity model pairs that are in the named
* group
*
* @param groupName
* The name of the group
* @param groupName The name of the group
* @return Map of entityName String keys and ModelEntity instance values
*/
Map<String, ModelEntity> getModelEntityMapByGroup(String groupName) throws GenericEntityException;
@@ -739,15 +738,16 @@ public interface Delegator {
void refreshSequencer();
/**
* Remove the Entities from the List from the persistent store. <br/>The
* List contains GenericEntity objects, can be either GenericPK or
* GenericValue. <br/>If a certain entity contains a complete primary key,
* the entity in the datasource corresponding to that primary key will be
* removed, this is like a removeByPrimary Key. <br/>On the other hand, if a
* certain entity is an incomplete or non primary key, if will behave like
* the removeByAnd method. <br/>These updates all happen in one transaction,
* so they will either all succeed or all fail, if the data source supports
* transactions.
* <p>Remove the Entities from the List from the persistent store.</p>
* <p>The List contains GenericEntity objects, can be either GenericPK or
* GenericValue. </p>
* <p>If a certain entity contains a complete primary key, the entity in
* the datasource corresponding to that primary key will be removed, this
* is like a removeByPrimary Key.</p>
* <p>On the other hand, if a certain entity is an incomplete or non
* primary key, if will behave like the removeByAnd method. </p>
* <p>These updates all happen in one transaction, so they will either
* all succeed or all fail, if the data source supports transactions.</p>
*
* @param dummyPKs
* Collection of GenericEntity instances containing the entities
@@ -858,14 +858,16 @@ public interface Delegator {
int store(GenericValue value) throws GenericEntityException;
/**
* Store the Entities from the List GenericValue instances to the persistent
* store. <br/>This is different than the normal store method in that the
* <p>Store the Entities from the List GenericValue instances to the persistent
* store.</p>
* <p>This is different than the normal store method in that the
* store method only does an update, while the storeAll method checks to see
* if each entity exists, then either does an insert or an update as
* appropriate. <br/>These updates all happen in one transaction, so they
* appropriate.</p>
* <p>These updates all happen in one transaction, so they
* will either all succeed or all fail, if the data source supports
* transactions. This is just like to othersToStore feature of the
* GenericEntity on a create or store.
* GenericEntity on a create or store.</p>
*
* @param values
* List of GenericValue instances containing the entities to
@@ -875,14 +877,16 @@ public interface Delegator {
int storeAll(List<GenericValue> values) throws GenericEntityException;
/**
* Store the Entities from the List GenericValue instances to the persistent
* store. <br/>This is different than the normal store method in that the
* <p>Store the Entities from the List GenericValue instances to the persistent
* store.</p>
* <p>This is different than the normal store method in that the
* store method only does an update, while the storeAll method checks to see
* if each entity exists, then either does an insert or an update as
* appropriate. <br/>These updates all happen in one transaction, so they
* appropriate.</p>
* <p>These updates all happen in one transaction, so they
* will either all succeed or all fail, if the data source supports
* transactions. This is just like to othersToStore feature of the
* GenericEntity on a create or store.
* GenericEntity on a create or store.</p>
*
* @param storeOptions
* An instance of EntityStoreOptions that specifies advanced store
@@ -896,7 +900,7 @@ public interface Delegator {
int storeAll(List<GenericValue> values, EntityStoreOptions storeOptions) throws GenericEntityException;
/**
* Store a group of values
* Store a group of values.
*
* @param entityName
* The name of the Entity as defined in the entity XML file
@@ -759,7 +759,7 @@ public class GenericEntity implements Map<String, Object>, LocalizedMap<Object>,
* definition as the resource name. To specify a resource name manually, use the other getResource method.
*
* So, the key in the resource bundle (properties file) should be as follows:
* <entity-name>.<field-name>.<pk-field-value-1>.<pk-field-value-2>...<pk-field-value-n>
* &lt;entity-name&gt;.&lt;field-name&gt;.&lt;pk-field-value-1&gt;.&lt;pk-field-value-2&gt;...&lt;pk-field-value-n&gt;
* For example:
* ProductType.description.FINISHED_GOOD
*
@@ -1419,8 +1419,8 @@ public class GenericEntity implements Map<String, Object>, LocalizedMap<Object>,
return tempResult;
}
/** Clones this GenericEntity, this is a shallow clone & uses the default shallow HashMap clone
*@return Object that is a clone of this GenericEntity
/** Clones this GenericEntity, this is a shallow clone and uses the default shallow HashMap clone
* @return Object that is a clone of this GenericEntity
*/
@Override
public Object clone() {
@@ -67,8 +67,8 @@ public class GenericPK extends GenericEntity {
return false;
}
/** Clones this GenericPK, this is a shallow clone & uses the default shallow HashMap clone
*@return Object that is a clone of this GenericPK
/** Clones this GenericPK, this is a shallow clone and uses the default shallow HashMap clone
* @return Object that is a clone of this GenericPK
*/
@Override
public Object clone() {
@@ -223,8 +223,8 @@ public class GenericValue extends GenericEntity {
return false;
}
/** Clones this GenericValue, this is a shallow clone & uses the default shallow HashMap clone
*@return Object that is a clone of this GenericValue
/** Clones this GenericValue, this is a shallow clone and uses the default shallow HashMap clone
* @return Object that is a clone of this GenericValue
*/
@Override
public Object clone() {
@@ -31,8 +31,8 @@ import org.apache.ofbiz.entity.config.model.Datasource;
import org.apache.ofbiz.entity.model.ModelEntity;
/**
* Represents the conditions to be used to constrain a query
* <br/>An EntityCondition can represent various type of constraints, including:
* <p>Represents the conditions to be used to constrain a query.</p>
* <p>An EntityCondition can represent various type of constraints, including:</p>
* <ul>
* <li>EntityConditionList: a list of EntityConditions, combined with the operator specified
* <li>EntityExpr: for simple expressions or expressions that combine EntityConditions
@@ -32,8 +32,8 @@ import org.apache.ofbiz.entity.model.ModelViewEntity;
import org.apache.ofbiz.entity.model.ModelViewEntity.ModelAlias;
/**
* Represents the conditions to be used to constrain a query
* <br/>An EntityCondition can represent various type of constraints, including:
* <p>Represents the conditions to be used to constrain a query.</p>
* <p>An EntityCondition can represent various type of constraints, including:</p>
* <ul>
* <li>EntityConditionList: a list of EntityConditions, combined with the operator specified
* <li>EntityExpr: for simple expressions or expressions that combine EntityConditions
@@ -22,8 +22,8 @@ package org.apache.ofbiz.entity.condition;
import java.util.List;
/**
* Represents the conditions to be used to constrain a query
* <br/>An EntityCondition can represent various type of constraints, including:
* <p>Represents the conditions to be used to constrain a query.</p>
* <p>An EntityCondition can represent various type of constraints, including:</p>
* <ul>
* <li>EntityConditionList: a list of EntityConditions, combined with the operator specified
* <li>EntityExpr: for simple expressions or expressions that combine EntityConditions
@@ -71,16 +71,14 @@ public class EntityQuery {
/** Construct an EntityQuery object for use against the specified Delegator
* @param delegator - The delegator instance to use for the query
* @return Returns a new EntityQuery object
* @param delegator The delegator instance to use for the query
*/
public static EntityQuery use(Delegator delegator) {
return new EntityQuery(delegator);
}
/** Construct an EntityQuery object for use against the specified Delegator
* @param delegator - The delegator instance to use for the query
* @return Returns a new EntityQuery object
* @param delegator The delegator instance to use for the query
*/
public EntityQuery(Delegator delegator) {
this.delegator = delegator;