Author: tchemit Date: 2010-01-29 18:42:17 +0100 (Fri, 29 Jan 2010) New Revision: 809 Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelAttribute.java trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelParameter.java Log: improve contract and javadoc Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelAttribute.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelAttribute.java 2010-01-29 17:41:08 UTC (rev 808) +++ trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelAttribute.java 2010-01-29 17:42:17 UTC (rev 809) @@ -33,109 +33,96 @@ * by : $Author$ */ public interface ObjectModelAttribute extends ObjectModelParameter { - /** - * Returns the type of this attribute. - * - * @return the type of this attribute. - */ - public String getType(); - + * Returns the type of this attribute. + * + * @return the type of this attribute. + */ + String getType(); /** - * Returns whether this attribute is an aggregate or not. - * - * @return a boolean indicating whether this attribute is an aggregate or not. - */ - public boolean isAggregate(); - + * Returns whether this attribute is an aggregate or not. + * + * @return {@code true} if this attribute is an aggregate or not. + */ + boolean isAggregate(); /** - * Returns whether this attribute is a composite or not. - * - * @return a boolean indicating whether this attribute is a composite or not. - */ - public boolean isComposite(); - + * Returns whether this attribute is a composite or not. + * + * @return {@code true} if this attribute is a composite or not. + */ + boolean isComposite(); /** - * Returns the visibility of this attribute. - * Possible values includes <tt>public</tt>, <tt>protected</tt> and <tt>private</tt>. - * - * @return the visibility of this attribute. - */ - public String getVisibility(); - + * Returns the visibility of this attribute. + * + * Possible values includes <tt>public</tt>, <tt>protected</tt> + * and <tt>private</tt>. + * + * @return the visibility of this attribute. + */ + String getVisibility(); /** * Returns whether this attribute reference a model classifier or not. * - * @return a boolean indicating whether this attribute reference a model classifier or not. + * @return a boolean indicating whether this attribute reference a model + * classifier or not. */ - public boolean referenceClassifier(); - + boolean referenceClassifier(); /** - * Returns the classifier referenced by this attribute or null if it does not reference a model classifier. - * - * @return the ObjectModelClassfifier referenced by this attribute or null if it does not reference a model classifier. - */ - public ObjectModelClassifier getClassifier(); - + * Returns the classifier referenced by this attribute or null if it does + * not reference a model classifier. + * + * @return the ObjectModelClassfifier referenced by this attribute or null + * if it does not reference a model classifier. + */ + ObjectModelClassifier getClassifier(); /** - * Returns the attribute used to reference this class at the other end of the association or null if this is not an association, or if it is not bi-directionnal. - * @see #getClassifier() - * - * @return the ObjectModelAttribute used to reference this class at the other end of the association or null if this is not an association, or if it is not bi-directionnal. - */ - public ObjectModelAttribute getReverseAttribute(); - + * Returns the attribute used to reference this class at the other end of + * the association or null if this is not an association, or if it is not + * bi-directionnal. + * + * @see #getClassifier() + * + * @return the ObjectModelAttribute used to reference this class at the + * other end of the association or null if this is not an + * association, or if it is not bi-directionnal. + */ + ObjectModelAttribute getReverseAttribute(); /** * Return attribute reserver attribute name. * * @return reverse attribute name or null */ - public String getReverseAttributeName(); - + String getReverseAttributeName(); /** * max multiplicity of the reverse attribute + * * @return max multiplicity of the reverse attribute */ - public int getReverseMaxMultiplicity(); - + int getReverseMaxMultiplicity(); /** - * Returns the association class associated with this association, or null if there is none. - * - * @return a ObjectModelClass corresponding to the association class associated with this association, or null if there is none. - */ - public ObjectModelClass getAssociationClass(); - + * @return a ObjectModelClass corresponding to the association class + * associated with this association, or null if there is none. + */ + ObjectModelClass getAssociationClass(); /** - * Returns whether this association has an associated association class, ot not. - * - * @return a boolean indicating whether this association has an associated association class, ot not. - */ - public boolean hasAssociationClass(); - + * @return {@code true} if this association has an associated association + * class, ot not. + */ + boolean hasAssociationClass(); /** - * Returns whether this attribute is static or not. - * - * @return a boolean indicating whether this attribute is static or not. + * @return {@code true} if this attribute is static or not. */ - public boolean isStatic(); - + boolean isStatic(); /** - * Returns whether this attribute is final or not. - * - * @return a boolean indicating whether this attribute is final or not. + * @return {@code true} if this attribute is final or not. */ - public boolean isFinal(); - + boolean isFinal(); /** - * true if this attribute is navigable - * @return true if this attribute is navigable + * @return {@code true} if this attribute is navigable */ - public boolean isNavigable(); - + boolean isNavigable(); /** - * true if this attribute is isIndexed - * @return true if this attribute is isIndexed + * @return {@code true} if this attribute is isIndexed */ - public boolean isIndexed(); - + boolean isIndexed(); } //ObjectModelAttribute Modified: trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelParameter.java =================================================================== --- trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelParameter.java 2010-01-29 17:41:08 UTC (rev 808) +++ trunk/eugene/src/main/java/org/nuiton/eugene/models/object/ObjectModelParameter.java 2010-01-29 17:42:17 UTC (rev 809) @@ -35,44 +35,47 @@ public interface ObjectModelParameter extends ObjectModelElement { /** - * Returns the type of this parameter. - * - * @return the type of this parameter. - */ - public String getType(); + * Returns the type of this parameter. + * + * @return the type of this parameter. + */ + String getType(); - /** - * Returns the minimal multiplicity of this parameter. - * The <tt>-1</tt> value means infinite. - * - * @return the minimal multiplicity of this parameter. - */ - public int getMinMultiplicity(); + /** + * Returns the minimal multiplicity of this parameter. + * The <tt>-1</tt> value means infinite. + * + * @return the minimal multiplicity of this parameter. + */ + int getMinMultiplicity(); /** - * Returns the maximal multiplicity of this parameter. - * The <tt>-1</tt> value means infinite. - * - * @return the maximal multiplicity of this parameter. - */ - public int getMaxMultiplicity(); + * Returns the maximal multiplicity of this parameter. + * The <tt>-1</tt> value means infinite. + * + * @return the maximal multiplicity of this parameter. + */ + int getMaxMultiplicity(); /** * true if this parameter is isOrdered - * @return true if this parameter is isOrdered + * + * @return {@code true} if this parameter is isOrdered */ - public boolean isOrdered(); + boolean isOrdered(); /** * true if this parameter is isUnique - * @return true if this parameter is isUnique + * + * @return {@code true} if this parameter is isUnique */ - public boolean isUnique(); + boolean isUnique(); /** * default value of this parameter + * * @return a String for the defaultValue (must be interpreted depending on the parameter type) */ - public String getDefaultValue(); + String getDefaultValue(); } //ObjectModelParameter