< prev index next >

src/java.xml.crypto/share/classes/com/sun/org/apache/xml/internal/security/encryption/EncryptedKey.java

Print this page

        

@@ -21,21 +21,21 @@
  * under the License.
  */
 package com.sun.org.apache.xml.internal.security.encryption;
 
 /**
- * The <code>EncryptedKey</code> element is used to transport encryption keys
+ * The {@code EncryptedKey} element is used to transport encryption keys
  * from the originator to a known recipient(s). It may be used as a stand-alone
  * XML document, be placed within an application document, or appear inside an
- * <code>EncryptedData</code> element as a child of a <code>ds:KeyInfo</code>
+ * {@code EncryptedData} element as a child of a {@code ds:KeyInfo}
  * element. The key value is always encrypted to the recipient(s). When
- * <code>EncryptedKey</code> is decrypted the resulting octets are made
- * available to the <code>EncryptionMethod</code> algorithm without any
+ * {@code EncryptedKey} is decrypted the resulting octets are made
+ * available to the {@code EncryptionMethod} algorithm without any
  * additional processing.
  * <p>
  * Its schema definition is as follows:
- * <xmp>
+ * <pre>{@code
  * <element name='EncryptedKey' type='xenc:EncryptedKeyType'/>
  * <complexType name='EncryptedKeyType'>
  *     <complexContent>
  *         <extension base='xenc:EncryptedType'>
  *             <sequence>

@@ -44,64 +44,64 @@
  *             </sequence>
  *             <attribute name='Recipient' type='string' use='optional'/>
  *         </extension>
  *     </complexContent>
  * </complexType>
- * </xmp>
+ * }</pre>
  *
  * @author Axl Mattheus
  */
 public interface EncryptedKey extends EncryptedType {
 
     /**
      * Returns a hint as to which recipient this encrypted key value is intended for.
      *
-     * @return the recipient of the <code>EncryptedKey</code>.
+     * @return the recipient of the {@code EncryptedKey}.
      */
     String getRecipient();
 
     /**
-     * Sets the recipient for this <code>EncryptedKey</code>.
+     * Sets the recipient for this {@code EncryptedKey}.
      *
-     * @param recipient the recipient for this <code>EncryptedKey</code>.
+     * @param recipient the recipient for this {@code EncryptedKey}.
      */
     void setRecipient(String recipient);
 
     /**
      * Returns pointers to data and keys encrypted using this key. The reference
-     * list may contain multiple references to <code>EncryptedKey</code> and
-     * <code>EncryptedData</code> elements. This is done using
-     * <code>KeyReference</code> and <code>DataReference</code> elements
+     * list may contain multiple references to {@code EncryptedKey} and
+     * {@code EncryptedData} elements. This is done using
+     * {@code KeyReference} and {@code DataReference} elements
      * respectively.
      *
-     * @return an <code>Iterator</code> over all the <code>ReferenceList</code>s
-     *   contained in this <code>EncryptedKey</code>.
+     * @return an {@code Iterator} over all the {@code ReferenceList}s
+     *   contained in this {@code EncryptedKey}.
      */
     ReferenceList getReferenceList();
 
     /**
-     * Sets the <code>ReferenceList</code> to the <code>EncryptedKey</code>.
+     * Sets the {@code ReferenceList} to the {@code EncryptedKey}.
      *
      * @param list a list of pointers to data elements encrypted using this key.
      */
     void setReferenceList(ReferenceList list);
 
     /**
      * Returns a user readable name with the key value. This may then be used to
-     * reference the key using the <code>ds:KeyName</code> element within
-     * <code>ds:KeyInfo</code>. The same <code>CarriedKeyName</code> label,
+     * reference the key using the {@code ds:KeyName} element within
+     * {@code ds:KeyInfo}. The same {@code CarriedKeyName} label,
      * unlike an ID type, may occur multiple times within a single document. The
-     * value of the key is to be the same in all <code>EncryptedKey</code>
-     * elements identified with the same <code>CarriedKeyName</code> label
+     * value of the key is to be the same in all {@code EncryptedKey}
+     * elements identified with the same {@code CarriedKeyName} label
      * within a single XML document.
      * <br>
      * <b>Note</b> that because whitespace is significant in the value of
-     * the <code>ds:KeyName</code> element, whitespace is also significant in
-     * the value of the <code>CarriedKeyName</code> element.
+     * the {@code ds:KeyName} element, whitespace is also significant in
+     * the value of the {@code CarriedKeyName} element.
      *
      * @return over all the carried names contained in
-     *   this <code>EncryptedKey</code>.
+     *   this {@code EncryptedKey}.
      */
     String getCarriedName();
 
     /**
      * Sets the carried name.
< prev index next >