Commit 4ce5445a authored by wmunsil's avatar wmunsil

OCAPRI-586: pick up javadoc changes from OCAP-HNEXT-R-11.1641-2.

parent b8626a42
......@@ -108,27 +108,36 @@ public abstract class MetadataNode
* removes an existing metadata entry.
*
* <p>
* The value argument must be either null or a reference to an instance
* of one of the following classes:
* If the key argument does not contain an "@" character, the value
* argument must be either null or a reference to an instance of one
* of the following classes:
* <ul>
* <li><code>org.dvb.application.AppID</code>
* <li><code>org.ocap.storage.ExtendedFileAccessPermissions</code>
* <li>a class extending <code>org.ocap.hn.content.MetadataNode</code>
* and not implementing <code>java.io.Serializable</code>
* <li>a nonarray class implementing <code>java.io.Serializable</code>
* (in which case the instance must be fully serializable)
* <li><code>T[]</code>, where <code>T</code> is one of the above
* </ul>
*
* <p>
* If the key argument contains an "@" character, the value argument
* must be either null or a reference to an instance of one of the
* following classes:
* If the key argument contains an "@" character but does not begin
* with an "@" character, the value argument must be either null or
* a reference to an instance of one of the following classes:
* <ul>
* <li><code>java.lang.String</code>
* <li><code>java.lang.String[]</code>
* </ul>
*
* <p>
* If the key argument begins with an "@" character, the value argument
* must be either null or a reference to an instance of the following
* class:
* <ul>
* <li><code>java.lang.String</code>
* </ul>
*
* <p>
* If the value argument is null or a reference to a zero-length array,
* any existing value associated with the key argument SHALL be removed.
* Otherwise, if a value is already associated with the key argument,
......@@ -157,9 +166,13 @@ public abstract class MetadataNode
* retrievable by the <code>getKey</code> method to this key.
* @param value Null or a reference to the value to associate with the key.
*
* @throws IllegalArgumentException if the value argument is neither null
* nor a reference to an instance of an acceptable class, or if the key
* argument contains an undeclared namespace prefix or a "#" character.
* @throws IllegalArgumentException if the key argument contains an
* undeclared namespace prefix or a "#" character, or if the value
* argument is neither null nor a reference to an instance of an
* acceptable class, or if the value argument is a reference to an
* instance of a class that implements
* <code>java.io.Serializable</code> but that instance cannot be
* successfully serialized.
* @throws SecurityException if the property identified by the key
* argument does not exist and the calling application does not have
* sufficient file access permissions to write to the
......@@ -176,27 +189,36 @@ public abstract class MetadataNode
* <code>ExtendedFileAccessPermissions</code>.
*
* <p>
* The value argument must be either null or a reference to an instance
* of one of the following classes:
* If the key argument does not contain an "@" character, the value
* argument must be either null or a reference to an instance of one
* of the following classes:
* <ul>
* <li><code>org.dvb.application.AppID</code>
* <li><code>org.ocap.storage.ExtendedFileAccessPermissions</code>
* <li>a class extending <code>org.ocap.hn.content.MetadataNode</code>
* and not implementing <code>java.io.Serializable</code>
* <li>a nonarray class implementing <code>java.io.Serializable</code>
* (in which case the instance must be fully serializable)
* <li><code>T[]</code>, where <code>T</code> is one of the above
* </ul>
*
* <p>
* If the key argument contains an "@" character, the value argument
* must be either null or a reference to an instance of one of the
* following classes:
* If the key argument contains an "@" character but does not begin
* with an "@" character, the value argument must be either null or
* a reference to an instance of one of the following classes:
* <ul>
* <li><code>java.lang.String</code>
* <li><code>java.lang.String[]</code>
* </ul>
*
* <p>
* If the key argument begins with an "@" character, the value argument
* must be either null or a reference to an instance of the following
* class:
* <ul>
* <li><code>java.lang.String</code>
* </ul>
*
* <p>
* If the value argument is null or a reference to a zero-length array,
* any existing value associated with the key argument SHALL be removed.
* Otherwise, if a value is already associated with the key argument,
......@@ -227,10 +249,13 @@ public abstract class MetadataNode
* @param efap The <code>ExtendedFileAccessPermissions</code> for the
* property added or modified by this method.
*
* @throws IllegalArgumentException if the value argument is neither null
* nor a reference to an instance of an acceptable class, or if the key
* argument contains an undeclared namespace prefix or a "#" character,
* or if the efap argument is null.
* @throws IllegalArgumentException if the key argument contains an
* undeclared namespace prefix or a "#" character, or if the value
* argument is neither null nor a reference to an instance of an
* acceptable class, or if the value argument is a reference to an
* instance of a class that implements
* <code>java.io.Serializable</code> but that instance cannot be
* successfully serialized, or if the efap argument is null.
* @throws SecurityException if the property identified by the key
* argument does not exist and the calling application does not have
* sufficient file access permissions to write to the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment