diff options
| -rw-r--r-- | src/pl/edu/mimuw/cloudatlas/model/AttributesMap.java | 26 | ||||
| -rw-r--r-- | src/pl/edu/mimuw/cloudatlas/model/ZMI.java | 28 |
2 files changed, 27 insertions, 27 deletions
diff --git a/src/pl/edu/mimuw/cloudatlas/model/AttributesMap.java b/src/pl/edu/mimuw/cloudatlas/model/AttributesMap.java index da13819..4065ad6 100644 --- a/src/pl/edu/mimuw/cloudatlas/model/AttributesMap.java +++ b/src/pl/edu/mimuw/cloudatlas/model/AttributesMap.java @@ -44,12 +44,12 @@ public class AttributesMap implements Iterable<Entry<Attribute, Value>>, Cloneab } /** - * Adds to this map a new <code>attribute</code> mapping to the specified <code>value</code>. The - * <code>attribute</code> cannot already exist in the map. To overwrite an existing attribute, use method + * Adds a new <code>attribute</code>-<code>value</code> mapping. The + * <code>attribute</code> cannot already exist in the map. To overwrite an existing attribute, use * {@link #addOrChange(Attribute, Value)} instead. * * @param attribute the attribute to add - * @param value the value for the <code>attribute</code> + * @param value the value for <code>attribute</code> * @throws IllegalArgumentException if the <code>attribute</code> already exists in this map * @throws NullPointerException if either the <code>attribute</code> or the <code>value</code> is <code>null</code>; * for null value, create a <code>Value</code> object containing <code>null</code> @@ -122,7 +122,7 @@ public class AttributesMap implements Iterable<Entry<Attribute, Value>>, Cloneab } /** - * Adds a new attribute< mapping to the specified <code>value</code> or overwrites an existing one. Convenient + * Adds a new attribute mapping to the specified <code>value</code> or overwrites an existing one. Convenient * version of {@link #addOrChange(Attribute, Value)}. * * @param name the attribute name @@ -165,13 +165,13 @@ public class AttributesMap implements Iterable<Entry<Attribute, Value>>, Cloneab } /** - * Gets the value mapped to the specified <code>attribute</code>. If such mapping does not exist, this method throws - * an exception. If this is not an expected behavior, use method {@link #getOrNull(Attribute)} instead. + * Gets the value mapped to the specified <code>attribute</code>. If such a mapping does not exist, this method throws + * an exception. If this is not an expected behavior, use {@link #getOrNull(Attribute)} instead. * * @param attribute the attribute to obtain - * @return the value mapped to the <code>attribute</code> - * @throws IllegalArgumentException if no value is mapped to the <code>attribute</code> - * @throws NullPointerException if the <code>attribute</code> is <code>null</code> + * @return the value mapped to <code>attribute</code> + * @throws IllegalArgumentException if no value is mapped to <code>attribute</code> + * @throws NullPointerException if <code>attribute</code> is <code>null</code> * @see #getOrNull(Attribute) * @see #get(String) */ @@ -200,7 +200,7 @@ public class AttributesMap implements Iterable<Entry<Attribute, Value>>, Cloneab * returns <code>null</code> if the requested mapping does not exist. * * @param attribute the attribute to obtain - * @return the value mapped to the <code>attribute</code> or <code>null</code> if it does not exist + * @return the value mapped to <code>attribute</code> or <code>null</code> if it does not exist * @throws NullPointerException if the <code>attribute</code> is <code>null</code> * @see #get(Attribute) * @see #getOrNull(String) @@ -223,11 +223,11 @@ public class AttributesMap implements Iterable<Entry<Attribute, Value>>, Cloneab } /** - * Removes the specified <code>attribute</code> and its value from this map. If the <code>attribute</code> does not - * exist, this method performs nothing. + * Removes the specified <code>attribute</code> and its value from this map. If <code>attribute</code> does not + * exist, this method doesn't do anything. * * @param attribute the attribute to remove - * @throws NullPointerException if the <code>attribute</code> is <code>null</code> + * @throws NullPointerException if <code>attribute</code> is <code>null</code> * @see #remove(String) */ public void remove(Attribute attribute) { diff --git a/src/pl/edu/mimuw/cloudatlas/model/ZMI.java b/src/pl/edu/mimuw/cloudatlas/model/ZMI.java index 3e3f3a2..a6b78da 100644 --- a/src/pl/edu/mimuw/cloudatlas/model/ZMI.java +++ b/src/pl/edu/mimuw/cloudatlas/model/ZMI.java @@ -31,7 +31,7 @@ import java.util.List; import java.util.Map.Entry; /** - * A zone management information. This object is a single node in a zone hierarchy. It stores zone attributes as well as + * A zone management information object. This object is a single node in a zone hierarchy. It stores zone attributes as well as * references to its father and sons in the tree. */ public class ZMI implements Cloneable { @@ -49,10 +49,10 @@ public class ZMI implements Cloneable { /** * Creates a new ZMI with the specified node as a father and empty sons list. This method does not perform any - * operation on the <code>father</code>. Especially, setting this object as a <code>father</code>'s son must be done + * operation on <code>father</code>. In particular, setting this object <code>father</code>'s son must be done * separately. * - * @param father a father of this ZMI + * @param father the father of this ZMI * @see #addSon(ZMI) */ public ZMI(ZMI father) { @@ -60,17 +60,17 @@ public class ZMI implements Cloneable { } /** - * Gets a father of this ZMI in a tree. + * Gets the father of this ZMI. * - * @return a father of this ZMI or <code>null</code> if this is the root zone + * @return the father of this ZMI or <code>null</code> if this is the root zone */ public ZMI getFather() { return father; } /** - * Sets or changes a father of this ZMI in a tree. This method does not perform any operation on the - * <code>father</code>. Especially, setting this object as a <code>father</code>'s son must be done separately. + * Sets or changes the father of this ZMI in the tree. This method does not perform any operation on + * <code>father</code>. In particular, setting this object as <code>father</code>'s son must be done separately. * * @param father a new father for this ZMI * @see #addSon(ZMI) @@ -80,17 +80,17 @@ public class ZMI implements Cloneable { } /** - * Gets a list of sons of this ZMI in a tree. Modifying a return value will cause an exception. + * Gets the list of sons of this ZMI. Modifying a value in the returned list will cause an exception. * - * @return + * @return the list of sons */ public List<ZMI> getSons() { return Collections.unmodifiableList(sons); } /** - * Adds the specified ZMI to the list of sons of this ZMI. This method does not perform any operation on a - * <code>son</code>. Especially, setting this object as a <code>son</code>'s father must be done separately. + * Adds the specified ZMI to the list of sons of this ZMI. This method does not perform any operation on + * <code>son</code>. In particular, setting this object as <code>son</code>'s father must be done separately. * * @param son * @see #ZMI(ZMI) @@ -101,8 +101,8 @@ public class ZMI implements Cloneable { } /** - * Removes the specified ZMI from the list of sons of this ZMI. This method does not perform any operation on a - * <code>son</code>. Especially, its father remains unchanged. + * Removes the specified ZMI from the list of sons of this ZMI. This method does not perform any operation on + * <code>son</code>. In particular, its father remains unchanged. * * @param son * @see #setFather(ZMI) @@ -135,7 +135,7 @@ public class ZMI implements Cloneable { } /** - * Creates an independent copy of a whole hierarchy. A returned ZMI has the same reference as a father (but the + * Creates an independent copy of a whole hierarchy. A returned ZMI has the same reference as father (but the * father does not have a reference to it as a son). For the root zone, the copy is completely independent, since * its father is <code>null</code>. * |