8133802: replace some <tt> tags (obsolete in html5) in security-libs docs

Reviewed-by: mullan
This commit is contained in:
Alexander Stepanov 2015-08-25 18:45:09 +03:00
parent 739a00037e
commit 572aef810c
40 changed files with 757 additions and 758 deletions

File diff suppressed because it is too large Load Diff

View File

@ -40,24 +40,24 @@ import sun.security.jca.GetInstance.Instance;
* exchange) protocol.
* <p>
* The keys involved in establishing a shared secret are created by one of the
* key generators (<code>KeyPairGenerator</code> or
* <code>KeyGenerator</code>), a <code>KeyFactory</code>, or as a result from
* key generators ({@code KeyPairGenerator} or
* {@code KeyGenerator}), a {@code KeyFactory}, or as a result from
* an intermediate phase of the key agreement protocol.
*
* <p> For each of the correspondents in the key exchange, <code>doPhase</code>
* <p> For each of the correspondents in the key exchange, {@code doPhase}
* needs to be called. For example, if this key exchange is with one other
* party, <code>doPhase</code> needs to be called once, with the
* <code>lastPhase</code> flag set to <code>true</code>.
* party, {@code doPhase} needs to be called once, with the
* {@code lastPhase} flag set to {@code true}.
* If this key exchange is
* with two other parties, <code>doPhase</code> needs to be called twice,
* the first time setting the <code>lastPhase</code> flag to
* <code>false</code>, and the second time setting it to <code>true</code>.
* with two other parties, {@code doPhase} needs to be called twice,
* the first time setting the {@code lastPhase} flag to
* {@code false}, and the second time setting it to {@code true}.
* There may be any number of parties involved in a key exchange.
*
* <p> Every implementation of the Java platform is required to support the
* following standard <code>KeyAgreement</code> algorithm:
* following standard {@code KeyAgreement} algorithm:
* <ul>
* <li><tt>DiffieHellman</tt></li>
* <li>{@code DiffieHellman}</li>
* </ul>
* This algorithm is described in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyAgreement">
@ -125,20 +125,20 @@ public class KeyAgreement {
}
/**
* Returns the algorithm name of this <code>KeyAgreement</code> object.
* Returns the algorithm name of this {@code KeyAgreement} object.
*
* <p>This is the same name that was specified in one of the
* <code>getInstance</code> calls that created this
* <code>KeyAgreement</code> object.
* {@code getInstance} calls that created this
* {@code KeyAgreement} object.
*
* @return the algorithm name of this <code>KeyAgreement</code> object.
* @return the algorithm name of this {@code KeyAgreement} object.
*/
public final String getAlgorithm() {
return this.algorithm;
}
/**
* Returns a <code>KeyAgreement</code> object that implements the
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
* <p> This method traverses the list of registered security Providers,
@ -157,7 +157,7 @@ public class KeyAgreement {
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @return the new <code>KeyAgreement</code> object.
* @return the new {@code KeyAgreement} object.
*
* @exception NullPointerException if the specified algorithm
* is null.
@ -186,7 +186,7 @@ public class KeyAgreement {
}
/**
* Returns a <code>KeyAgreement</code> object that implements the
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
* <p> A new KeyAgreement object encapsulating the
@ -206,7 +206,7 @@ public class KeyAgreement {
*
* @param provider the name of the provider.
*
* @return the new <code>KeyAgreement</code> object.
* @return the new {@code KeyAgreement} object.
*
* @exception NullPointerException if the specified algorithm
* is null.
@ -218,7 +218,7 @@ public class KeyAgreement {
* @exception NoSuchProviderException if the specified provider is not
* registered in the security provider list.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null or empty.
*
* @see java.security.Provider
@ -233,7 +233,7 @@ public class KeyAgreement {
}
/**
* Returns a <code>KeyAgreement</code> object that implements the
* Returns a {@code KeyAgreement} object that implements the
* specified key agreement algorithm.
*
* <p> A new KeyAgreement object encapsulating the
@ -250,7 +250,7 @@ public class KeyAgreement {
*
* @param provider the provider.
*
* @return the new <code>KeyAgreement</code> object.
* @return the new {@code KeyAgreement} object.
*
* @exception NullPointerException if the specified algorithm
* is null.
@ -259,7 +259,7 @@ public class KeyAgreement {
* implementation for the specified algorithm is not available
* from the specified Provider object.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null.
*
* @see java.security.Provider
@ -408,9 +408,9 @@ public class KeyAgreement {
}
/**
* Returns the provider of this <code>KeyAgreement</code> object.
* Returns the provider of this {@code KeyAgreement} object.
*
* @return the provider of this <code>KeyAgreement</code> object
* @return the provider of this {@code KeyAgreement} object
*/
public final Provider getProvider() {
chooseFirstProvider();
@ -447,10 +447,10 @@ public class KeyAgreement {
* parameters required for this key agreement.
*
* <p> If the key agreement algorithm requires random bytes, it gets them
* from the given source of randomness, <code>random</code>.
* from the given source of randomness, {@code random}.
* However, if the underlying
* algorithm implementation does not require any random bytes,
* <code>random</code> is ignored.
* {@code random} is ignored.
*
* @param key the party's private information. For example, in the case
* of the Diffie-Hellman key agreement, this would be the party's own
@ -570,9 +570,9 @@ public class KeyAgreement {
/**
* Generates the shared secret and returns it in a new buffer.
*
* <p>This method resets this <code>KeyAgreement</code> object, so that it
* <p>This method resets this {@code KeyAgreement} object, so that it
* can be reused for further key agreements. Unless this key agreement is
* reinitialized with one of the <code>init</code> methods, the same
* reinitialized with one of the {@code init} methods, the same
* private information and algorithm parameters will be used for
* subsequent key agreements.
*
@ -588,23 +588,23 @@ public class KeyAgreement {
/**
* Generates the shared secret, and places it into the buffer
* <code>sharedSecret</code>, beginning at <code>offset</code> inclusive.
* {@code sharedSecret}, beginning at {@code offset} inclusive.
*
* <p>If the <code>sharedSecret</code> buffer is too small to hold the
* result, a <code>ShortBufferException</code> is thrown.
* <p>If the {@code sharedSecret} buffer is too small to hold the
* result, a {@code ShortBufferException} is thrown.
* In this case, this call should be repeated with a larger output buffer.
*
* <p>This method resets this <code>KeyAgreement</code> object, so that it
* <p>This method resets this {@code KeyAgreement} object, so that it
* can be reused for further key agreements. Unless this key agreement is
* reinitialized with one of the <code>init</code> methods, the same
* reinitialized with one of the {@code init} methods, the same
* private information and algorithm parameters will be used for
* subsequent key agreements.
*
* @param sharedSecret the buffer for the shared secret
* @param offset the offset in <code>sharedSecret</code> where the
* @param offset the offset in {@code sharedSecret} where the
* shared secret will be stored
*
* @return the number of bytes placed into <code>sharedSecret</code>
* @return the number of bytes placed into {@code sharedSecret}
*
* @exception IllegalStateException if this key agreement has not been
* completed yet
@ -619,12 +619,12 @@ public class KeyAgreement {
}
/**
* Creates the shared secret and returns it as a <code>SecretKey</code>
* Creates the shared secret and returns it as a {@code SecretKey}
* object of the specified algorithm.
*
* <p>This method resets this <code>KeyAgreement</code> object, so that it
* <p>This method resets this {@code KeyAgreement} object, so that it
* can be reused for further key agreements. Unless this key agreement is
* reinitialized with one of the <code>init</code> methods, the same
* reinitialized with one of the {@code init} methods, the same
* private information and algorithm parameters will be used for
* subsequent key agreements.
*

View File

@ -38,7 +38,7 @@ import sun.security.util.Debug;
/**
* This class provides the functionality of a secret (symmetric) key generator.
*
* <p>Key generators are constructed using one of the <code>getInstance</code>
* <p>Key generators are constructed using one of the {@code getInstance}
* class methods of this class.
*
* <p>KeyGenerator objects are reusable, i.e., after a key has been
@ -57,14 +57,14 @@ import sun.security.util.Debug;
* {@link #init(int, java.security.SecureRandom) init}
* method in this KeyGenerator class that takes these two universally
* shared types of arguments. There is also one that takes just a
* <code>keysize</code> argument, and uses the SecureRandom implementation
* {@code keysize} argument, and uses the SecureRandom implementation
* of the highest-priority installed provider as the source of randomness
* (or a system-provided source of randomness if none of the installed
* providers supply a SecureRandom implementation), and one that takes just a
* source of randomness.
*
* <p>Since no other parameters are specified when you call the above
* algorithm-independent <code>init</code> methods, it is up to the
* algorithm-independent {@code init} methods, it is up to the
* provider what to do about the algorithm-specific parameters (if any) to be
* associated with each of the keys.
*
@ -72,8 +72,8 @@ import sun.security.util.Debug;
* <p>For situations where a set of algorithm-specific parameters already
* exists, there are two
* {@link #init(java.security.spec.AlgorithmParameterSpec) init}
* methods that have an <code>AlgorithmParameterSpec</code>
* argument. One also has a <code>SecureRandom</code> argument, while the
* methods that have an {@code AlgorithmParameterSpec}
* argument. One also has a {@code SecureRandom} argument, while the
* other uses the SecureRandom implementation
* of the highest-priority installed provider as the source of randomness
* (or a system-provided source of randomness if none of the installed
@ -81,18 +81,18 @@ import sun.security.util.Debug;
* </ul>
*
* <p>In case the client does not explicitly initialize the KeyGenerator
* (via a call to an <code>init</code> method), each provider must
* (via a call to an {@code init} method), each provider must
* supply (and document) a default initialization.
*
* <p> Every implementation of the Java platform is required to support the
* following standard <code>KeyGenerator</code> algorithms with the keysizes in
* following standard {@code KeyGenerator} algorithms with the keysizes in
* parentheses:
* <ul>
* <li><tt>AES</tt> (128)</li>
* <li><tt>DES</tt> (56)</li>
* <li><tt>DESede</tt> (168)</li>
* <li><tt>HmacSHA1</tt></li>
* <li><tt>HmacSHA256</tt></li>
* <li>{@code AES} (128)</li>
* <li>{@code DES} (56)</li>
* <li>{@code DESede} (168)</li>
* <li>{@code HmacSHA1}</li>
* <li>{@code HmacSHA256}</li>
* </ul>
* These algorithms are described in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyGenerator">
@ -177,20 +177,20 @@ public class KeyGenerator {
}
/**
* Returns the algorithm name of this <code>KeyGenerator</code> object.
* Returns the algorithm name of this {@code KeyGenerator} object.
*
* <p>This is the same name that was specified in one of the
* <code>getInstance</code> calls that created this
* <code>KeyGenerator</code> object.
* {@code getInstance} calls that created this
* {@code KeyGenerator} object.
*
* @return the algorithm name of this <code>KeyGenerator</code> object.
* @return the algorithm name of this {@code KeyGenerator} object.
*/
public final String getAlgorithm() {
return this.algorithm;
}
/**
* Returns a <code>KeyGenerator</code> object that generates secret keys
* Returns a {@code KeyGenerator} object that generates secret keys
* for the specified algorithm.
*
* <p> This method traverses the list of registered security Providers,
@ -208,7 +208,7 @@ public class KeyGenerator {
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @return the new <code>KeyGenerator</code> object.
* @return the new {@code KeyGenerator} object.
*
* @exception NullPointerException if the specified algorithm is null.
*
@ -224,7 +224,7 @@ public class KeyGenerator {
}
/**
* Returns a <code>KeyGenerator</code> object that generates secret keys
* Returns a {@code KeyGenerator} object that generates secret keys
* for the specified algorithm.
*
* <p> A new KeyGenerator object encapsulating the
@ -243,7 +243,7 @@ public class KeyGenerator {
*
* @param provider the name of the provider.
*
* @return the new <code>KeyGenerator</code> object.
* @return the new {@code KeyGenerator} object.
*
* @exception NullPointerException if the specified algorithm is null.
*
@ -254,7 +254,7 @@ public class KeyGenerator {
* @exception NoSuchProviderException if the specified provider is not
* registered in the security provider list.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null or empty.
*
* @see java.security.Provider
@ -269,7 +269,7 @@ public class KeyGenerator {
}
/**
* Returns a <code>KeyGenerator</code> object that generates secret keys
* Returns a {@code KeyGenerator} object that generates secret keys
* for the specified algorithm.
*
* <p> A new KeyGenerator object encapsulating the
@ -285,7 +285,7 @@ public class KeyGenerator {
*
* @param provider the provider.
*
* @return the new <code>KeyGenerator</code> object.
* @return the new {@code KeyGenerator} object.
*
* @exception NullPointerException if the specified algorithm is null.
*
@ -293,7 +293,7 @@ public class KeyGenerator {
* implementation for the specified algorithm is not available
* from the specified Provider object.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null.
*
* @see java.security.Provider
@ -307,9 +307,9 @@ public class KeyGenerator {
}
/**
* Returns the provider of this <code>KeyGenerator</code> object.
* Returns the provider of this {@code KeyGenerator} object.
*
* @return the provider of this <code>KeyGenerator</code> object
* @return the provider of this {@code KeyGenerator} object
*/
public final Provider getProvider() {
synchronized (lock) {
@ -437,7 +437,7 @@ public class KeyGenerator {
* @param params the key generation parameters
* @param random the source of randomness for this key generator
*
* @exception InvalidAlgorithmParameterException if <code>params</code> is
* @exception InvalidAlgorithmParameterException if {@code params} is
* inappropriate for this key generator
*/
public final void init(AlgorithmParameterSpec params, SecureRandom random)

View File

@ -54,11 +54,11 @@ import sun.security.jca.GetInstance.Instance;
* specified in RFC 2104.
*
* <p> Every implementation of the Java platform is required to support
* the following standard <code>Mac</code> algorithms:
* the following standard {@code Mac} algorithms:
* <ul>
* <li><tt>HmacMD5</tt></li>
* <li><tt>HmacSHA1</tt></li>
* <li><tt>HmacSHA256</tt></li>
* <li>{@code HmacMD5}</li>
* <li>{@code HmacSHA1}</li>
* <li>{@code HmacSHA256}</li>
* </ul>
* These algorithms are described in the
* <a href="{@docRoot}/../technotes/guides/security/StandardNames.html#Mac">
@ -127,20 +127,20 @@ public class Mac implements Cloneable {
}
/**
* Returns the algorithm name of this <code>Mac</code> object.
* Returns the algorithm name of this {@code Mac} object.
*
* <p>This is the same name that was specified in one of the
* <code>getInstance</code> calls that created this
* <code>Mac</code> object.
* {@code getInstance} calls that created this
* {@code Mac} object.
*
* @return the algorithm name of this <code>Mac</code> object.
* @return the algorithm name of this {@code Mac} object.
*/
public final String getAlgorithm() {
return this.algorithm;
}
/**
* Returns a <code>Mac</code> object that implements the
* Returns a {@code Mac} object that implements the
* specified MAC algorithm.
*
* <p> This method traverses the list of registered security Providers,
@ -158,7 +158,7 @@ public class Mac implements Cloneable {
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @return the new <code>Mac</code> object.
* @return the new {@code Mac} object.
*
* @exception NoSuchAlgorithmException if no Provider supports a
* MacSpi implementation for the
@ -183,7 +183,7 @@ public class Mac implements Cloneable {
}
/**
* Returns a <code>Mac</code> object that implements the
* Returns a {@code Mac} object that implements the
* specified MAC algorithm.
*
* <p> A new Mac object encapsulating the
@ -202,7 +202,7 @@ public class Mac implements Cloneable {
*
* @param provider the name of the provider.
*
* @return the new <code>Mac</code> object.
* @return the new {@code Mac} object.
*
* @exception NoSuchAlgorithmException if a MacSpi
* implementation for the specified algorithm is not
@ -211,7 +211,7 @@ public class Mac implements Cloneable {
* @exception NoSuchProviderException if the specified provider is not
* registered in the security provider list.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null or empty.
*
* @see java.security.Provider
@ -224,7 +224,7 @@ public class Mac implements Cloneable {
}
/**
* Returns a <code>Mac</code> object that implements the
* Returns a {@code Mac} object that implements the
* specified MAC algorithm.
*
* <p> A new Mac object encapsulating the
@ -240,13 +240,13 @@ public class Mac implements Cloneable {
*
* @param provider the provider.
*
* @return the new <code>Mac</code> object.
* @return the new {@code Mac} object.
*
* @exception NoSuchAlgorithmException if a MacSpi
* implementation for the specified algorithm is not available
* from the specified Provider object.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null.
*
* @see java.security.Provider
@ -380,9 +380,9 @@ public class Mac implements Cloneable {
}
/**
* Returns the provider of this <code>Mac</code> object.
* Returns the provider of this {@code Mac} object.
*
* @return the provider of this <code>Mac</code> object.
* @return the provider of this {@code Mac} object.
*/
public final Provider getProvider() {
chooseFirstProvider();
@ -400,7 +400,7 @@ public class Mac implements Cloneable {
}
/**
* Initializes this <code>Mac</code> object with the given key.
* Initializes this {@code Mac} object with the given key.
*
* @param key the key.
*
@ -426,7 +426,7 @@ public class Mac implements Cloneable {
}
/**
* Initializes this <code>Mac</code> object with the given key and
* Initializes this {@code Mac} object with the given key and
* algorithm parameters.
*
* @param key the key.
@ -457,7 +457,7 @@ public class Mac implements Cloneable {
*
* @param input the input byte to be processed.
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final void update(byte input) throws IllegalStateException {
@ -473,7 +473,7 @@ public class Mac implements Cloneable {
*
* @param input the array of bytes to be processed.
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final void update(byte[] input) throws IllegalStateException {
@ -487,14 +487,14 @@ public class Mac implements Cloneable {
}
/**
* Processes the first <code>len</code> bytes in <code>input</code>,
* starting at <code>offset</code> inclusive.
* Processes the first {@code len} bytes in {@code input},
* starting at {@code offset} inclusive.
*
* @param input the input buffer.
* @param offset the offset in <code>input</code> where the input starts.
* @param offset the offset in {@code input} where the input starts.
* @param len the number of bytes to process.
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final void update(byte[] input, int offset, int len)
@ -512,14 +512,14 @@ public class Mac implements Cloneable {
}
/**
* Processes <code>input.remaining()</code> bytes in the ByteBuffer
* <code>input</code>, starting at <code>input.position()</code>.
* Processes {@code input.remaining()} bytes in the ByteBuffer
* {@code input}, starting at {@code input.position()}.
* Upon return, the buffer's position will be equal to its limit;
* its limit will not have changed.
*
* @param input the ByteBuffer
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
* @since 1.5
*/
@ -537,20 +537,20 @@ public class Mac implements Cloneable {
/**
* Finishes the MAC operation.
*
* <p>A call to this method resets this <code>Mac</code> object to the
* <p>A call to this method resets this {@code Mac} object to the
* state it was in when previously initialized via a call to
* <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
* That is, the object is reset and available to generate another MAC from
* the same key, if desired, via new calls to <code>update</code> and
* <code>doFinal</code>.
* (In order to reuse this <code>Mac</code> object with a different key,
* it must be reinitialized via a call to <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* the same key, if desired, via new calls to {@code update} and
* {@code doFinal}.
* (In order to reuse this {@code Mac} object with a different key,
* it must be reinitialized via a call to {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
*
* @return the MAC result.
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final byte[] doFinal() throws IllegalStateException {
@ -566,27 +566,27 @@ public class Mac implements Cloneable {
/**
* Finishes the MAC operation.
*
* <p>A call to this method resets this <code>Mac</code> object to the
* <p>A call to this method resets this {@code Mac} object to the
* state it was in when previously initialized via a call to
* <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
* That is, the object is reset and available to generate another MAC from
* the same key, if desired, via new calls to <code>update</code> and
* <code>doFinal</code>.
* (In order to reuse this <code>Mac</code> object with a different key,
* it must be reinitialized via a call to <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* the same key, if desired, via new calls to {@code update} and
* {@code doFinal}.
* (In order to reuse this {@code Mac} object with a different key,
* it must be reinitialized via a call to {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
*
* <p>The MAC result is stored in <code>output</code>, starting at
* <code>outOffset</code> inclusive.
* <p>The MAC result is stored in {@code output}, starting at
* {@code outOffset} inclusive.
*
* @param output the buffer where the MAC result is stored
* @param outOffset the offset in <code>output</code> where the MAC is
* @param outOffset the offset in {@code output} where the MAC is
* stored
*
* @exception ShortBufferException if the given output buffer is too small
* to hold the result
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final void doFinal(byte[] output, int outOffset)
@ -609,21 +609,21 @@ public class Mac implements Cloneable {
/**
* Processes the given array of bytes and finishes the MAC operation.
*
* <p>A call to this method resets this <code>Mac</code> object to the
* <p>A call to this method resets this {@code Mac} object to the
* state it was in when previously initialized via a call to
* <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
* That is, the object is reset and available to generate another MAC from
* the same key, if desired, via new calls to <code>update</code> and
* <code>doFinal</code>.
* (In order to reuse this <code>Mac</code> object with a different key,
* it must be reinitialized via a call to <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* the same key, if desired, via new calls to {@code update} and
* {@code doFinal}.
* (In order to reuse this {@code Mac} object with a different key,
* it must be reinitialized via a call to {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
*
* @param input data in bytes
* @return the MAC result.
*
* @exception IllegalStateException if this <code>Mac</code> has not been
* @exception IllegalStateException if this {@code Mac} has not been
* initialized.
*/
public final byte[] doFinal(byte[] input) throws IllegalStateException
@ -637,18 +637,18 @@ public class Mac implements Cloneable {
}
/**
* Resets this <code>Mac</code> object.
* Resets this {@code Mac} object.
*
* <p>A call to this method resets this <code>Mac</code> object to the
* <p>A call to this method resets this {@code Mac} object to the
* state it was in when previously initialized via a call to
* <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
* That is, the object is reset and available to generate another MAC from
* the same key, if desired, via new calls to <code>update</code> and
* <code>doFinal</code>.
* (In order to reuse this <code>Mac</code> object with a different key,
* it must be reinitialized via a call to <code>init(Key)</code> or
* <code>init(Key, AlgorithmParameterSpec)</code>.
* the same key, if desired, via new calls to {@code update} and
* {@code doFinal}.
* (In order to reuse this {@code Mac} object with a different key,
* it must be reinitialized via a call to {@code init(Key)} or
* {@code init(Key, AlgorithmParameterSpec)}.
*/
public final void reset() {
chooseFirstProvider();
@ -661,7 +661,7 @@ public class Mac implements Cloneable {
* @return a clone if the provider implementation is cloneable.
*
* @exception CloneNotSupportedException if this is called on a
* delegate that does not support <code>Cloneable</code>.
* delegate that does not support {@code Cloneable}.
*/
public final Object clone() throws CloneNotSupportedException {
chooseFirstProvider();

View File

@ -38,7 +38,7 @@ import sun.security.jca.GetInstance.Instance;
* This class represents a factory for secret keys.
*
* <P> Key factories are used to convert <I>keys</I> (opaque
* cryptographic keys of type <code>Key</code>) into <I>key specifications</I>
* cryptographic keys of type {@code Key}) into <I>key specifications</I>
* (transparent representations of the underlying key material), and vice
* versa.
* Secret key factories operate only on secret (symmetric) keys.
@ -53,16 +53,16 @@ import sun.security.jca.GetInstance.Instance;
* {@link #getKeySpec(javax.crypto.SecretKey, java.lang.Class) getKeySpec}
* methods.
* For example, the DES secret-key factory supplied by the "SunJCE" provider
* supports <code>DESKeySpec</code> as a transparent representation of DES
* supports {@code DESKeySpec} as a transparent representation of DES
* keys, and that provider's secret-key factory for Triple DES keys supports
* <code>DESedeKeySpec</code> as a transparent representation of Triple DES
* {@code DESedeKeySpec} as a transparent representation of Triple DES
* keys.
*
* <p> Every implementation of the Java platform is required to support the
* following standard <code>SecretKeyFactory</code> algorithms:
* following standard {@code SecretKeyFactory} algorithms:
* <ul>
* <li><tt>DES</tt></li>
* <li><tt>DESede</tt></li>
* <li>{@code DES}</li>
* <li>{@code DESede}</li>
* </ul>
* These algorithms are described in the <a href=
* "{@docRoot}/../technotes/guides/security/StandardNames.html#SecretKeyFactory">
@ -125,7 +125,7 @@ public class SecretKeyFactory {
}
/**
* Returns a <code>SecretKeyFactory</code> object that converts
* Returns a {@code SecretKeyFactory} object that converts
* secret keys of the specified algorithm.
*
* <p> This method traverses the list of registered security Providers,
@ -144,7 +144,7 @@ public class SecretKeyFactory {
* Java Cryptography Architecture Standard Algorithm Name Documentation</a>
* for information about standard algorithm names.
*
* @return the new <code>SecretKeyFactory</code> object.
* @return the new {@code SecretKeyFactory} object.
*
* @exception NullPointerException if the specified algorithm
* is null.
@ -161,7 +161,7 @@ public class SecretKeyFactory {
}
/**
* Returns a <code>SecretKeyFactory</code> object that converts
* Returns a {@code SecretKeyFactory} object that converts
* secret keys of the specified algorithm.
*
* <p> A new SecretKeyFactory object encapsulating the
@ -181,7 +181,7 @@ public class SecretKeyFactory {
*
* @param provider the name of the provider.
*
* @return the new <code>SecretKeyFactory</code> object.
* @return the new {@code SecretKeyFactory} object.
*
* @exception NoSuchAlgorithmException if a SecretKeyFactorySpi
* implementation for the specified algorithm is not
@ -193,7 +193,7 @@ public class SecretKeyFactory {
* @throws NoSuchProviderException if the specified provider is not
* registered in the security provider list.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null or empty.
*
* @see java.security.Provider
@ -208,7 +208,7 @@ public class SecretKeyFactory {
}
/**
* Returns a <code>SecretKeyFactory</code> object that converts
* Returns a {@code SecretKeyFactory} object that converts
* secret keys of the specified algorithm.
*
* <p> A new SecretKeyFactory object encapsulating the
@ -225,7 +225,7 @@ public class SecretKeyFactory {
*
* @param provider the provider.
*
* @return the new <code>SecretKeyFactory</code> object.
* @return the new {@code SecretKeyFactory} object.
*
* @exception NullPointerException if the specified algorithm
* is null.
@ -234,7 +234,7 @@ public class SecretKeyFactory {
* implementation for the specified algorithm is not available
* from the specified Provider object.
*
* @exception IllegalArgumentException if the <code>provider</code>
* @exception IllegalArgumentException if the {@code provider}
* is null.
*
* @see java.security.Provider
@ -248,9 +248,9 @@ public class SecretKeyFactory {
}
/**
* Returns the provider of this <code>SecretKeyFactory</code> object.
* Returns the provider of this {@code SecretKeyFactory} object.
*
* @return the provider of this <code>SecretKeyFactory</code> object
* @return the provider of this {@code SecretKeyFactory} object
*/
public final Provider getProvider() {
synchronized (lock) {
@ -261,13 +261,13 @@ public class SecretKeyFactory {
}
/**
* Returns the algorithm name of this <code>SecretKeyFactory</code> object.
* Returns the algorithm name of this {@code SecretKeyFactory} object.
*
* <p>This is the same name that was specified in one of the
* <code>getInstance</code> calls that created this
* <code>SecretKeyFactory</code> object.
* {@code getInstance} calls that created this
* {@code SecretKeyFactory} object.
*
* @return the algorithm name of this <code>SecretKeyFactory</code>
* @return the algorithm name of this {@code SecretKeyFactory}
* object.
*/
public final String getAlgorithm() {
@ -314,7 +314,7 @@ public class SecretKeyFactory {
}
/**
* Generates a <code>SecretKey</code> object from the provided key
* Generates a {@code SecretKey} object from the provided key
* specification (key material).
*
* @param keySpec the specification (key material) of the secret key
@ -361,9 +361,9 @@ public class SecretKeyFactory {
*
* @exception InvalidKeySpecException if the requested key specification is
* inappropriate for the given key (e.g., the algorithms associated with
* <code>key</code> and <code>keySpec</code> do not match, or
* <code>key</code> references a key on a cryptographic hardware device
* whereas <code>keySpec</code> is the specification of a software-based
* {@code key} and {@code keySpec} do not match, or
* {@code key} references a key on a cryptographic hardware device
* whereas {@code keySpec} is the specification of a software-based
* key), or the given key cannot be dealt with
* (e.g., the given key has an algorithm or format not supported by this
* secret-key factory).

View File

@ -35,7 +35,7 @@ import java.security.spec.AlgorithmParameterSpec;
* <p> The parameters consist of an effective key size and optionally
* an 8-byte initialization vector (IV) (only in feedback mode).
*
* <p> This class can be used to initialize a <code>Cipher</code> object that
* <p> This class can be used to initialize a {@code Cipher} object that
* implements the <i>RC2</i> algorithm.
*
* @author Jan Luehe
@ -62,12 +62,12 @@ public class RC2ParameterSpec implements AlgorithmParameterSpec {
* (in bits) and an 8-byte IV.
*
* <p> The bytes that constitute the IV are those between
* <code>iv[0]</code> and <code>iv[7]</code> inclusive.
* {@code iv[0]} and {@code iv[7]} inclusive.
*
* @param effectiveKeyBits the effective key size in bits.
* @param iv the buffer with the 8-byte IV. The first 8 bytes of
* the buffer are copied to protect against subsequent modification.
* @exception IllegalArgumentException if <code>iv</code> is null.
* @exception IllegalArgumentException if {@code iv} is null.
*/
public RC2ParameterSpec(int effectiveKeyBits, byte[] iv) {
this(effectiveKeyBits, iv, 0);
@ -77,18 +77,18 @@ public class RC2ParameterSpec implements AlgorithmParameterSpec {
* Constructs a parameter set for RC2 from the given effective key size
* (in bits) and IV.
*
* <p> The IV is taken from <code>iv</code>, starting at
* <code>offset</code> inclusive.
* <p> The IV is taken from {@code iv}, starting at
* {@code offset} inclusive.
* The bytes that constitute the IV are those between
* <code>iv[offset]</code> and <code>iv[offset+7]</code> inclusive.
* {@code iv[offset]} and {@code iv[offset+7]} inclusive.
*
* @param effectiveKeyBits the effective key size in bits.
* @param iv the buffer with the IV. The first 8 bytes
* of the buffer beginning at <code>offset</code> inclusive
* of the buffer beginning at {@code offset} inclusive
* are copied to protect against subsequent modification.
* @param offset the offset in <code>iv</code> where the 8-byte IV
* @param offset the offset in {@code iv} where the 8-byte IV
* starts.
* @exception IllegalArgumentException if <code>iv</code> is null.
* @exception IllegalArgumentException if {@code iv} is null.
*/
public RC2ParameterSpec(int effectiveKeyBits, byte[] iv, int offset) {
this.effectiveKeyBits = effectiveKeyBits;
@ -124,12 +124,12 @@ public class RC2ParameterSpec implements AlgorithmParameterSpec {
* Tests for equality between the specified object and this
* object. Two RC2ParameterSpec objects are considered equal if their
* effective key sizes and IVs are equal.
* (Two IV references are considered equal if both are <tt>null</tt>.)
* (Two IV references are considered equal if both are {@code null}.)
*
* @param obj the object to test for equality with this object.
*
* @return true if the objects are considered equal, false if
* <code>obj</code> is null or otherwise.
* {@code obj} is null or otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) {

View File

@ -35,7 +35,7 @@ import java.security.spec.AlgorithmParameterSpec;
* <p> The parameters consist of a version number, a rounds count, a word
* size, and optionally an initialization vector (IV) (only in feedback mode).
*
* <p> This class can be used to initialize a <code>Cipher</code> object that
* <p> This class can be used to initialize a {@code Cipher} object that
* implements the <i>RC5</i> algorithm as supplied by
* <a href="http://www.rsa.com">RSA Security LLC</a>,
* or any parties authorized by RSA Security.
@ -71,16 +71,16 @@ public class RC5ParameterSpec implements AlgorithmParameterSpec {
*
* <p> Note that the size of the IV (block size) must be twice the word
* size. The bytes that constitute the IV are those between
* <code>iv[0]</code> and <code>iv[2*(wordSize/8)-1]</code> inclusive.
* {@code iv[0]} and {@code iv[2*(wordSize/8)-1]} inclusive.
*
* @param version the version.
* @param rounds the number of rounds.
* @param wordSize the word size in bits.
* @param iv the buffer with the IV. The first <code>2*(wordSize/8)
* </code> bytes of the buffer are copied to protect against subsequent
* @param iv the buffer with the IV. The first {@code 2*(wordSize/8)}
* bytes of the buffer are copied to protect against subsequent
* modification.
* @exception IllegalArgumentException if <code>iv</code> is
* <code>null</code> or {@code (iv.length < 2 * (wordSize / 8))}
* @exception IllegalArgumentException if {@code iv} is
* {@code null} or {@code (iv.length < 2 * (wordSize / 8))}
*/
public RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv) {
this(version, rounds, wordSize, iv, 0);
@ -90,23 +90,23 @@ public class RC5ParameterSpec implements AlgorithmParameterSpec {
* Constructs a parameter set for RC5 from the given version, number of
* rounds, word size (in bits), and IV.
*
* <p> The IV is taken from <code>iv</code>, starting at
* <code>offset</code> inclusive.
* <p> The IV is taken from {@code iv}, starting at
* {@code offset} inclusive.
* Note that the size of the IV (block size), starting at
* <code>offset</code> inclusive, must be twice the word size.
* {@code offset} inclusive, must be twice the word size.
* The bytes that constitute the IV are those between
* <code>iv[offset]</code> and <code>iv[offset+2*(wordSize/8)-1]</code>
* {@code iv[offset]} and {@code iv[offset+2*(wordSize/8)-1]}
* inclusive.
*
* @param version the version.
* @param rounds the number of rounds.
* @param wordSize the word size in bits.
* @param iv the buffer with the IV. The first <code>2*(wordSize/8)
* </code> bytes of the buffer beginning at <code>offset</code>
* @param iv the buffer with the IV. The first {@code 2*(wordSize/8)}
* bytes of the buffer beginning at {@code offset}
* inclusive are copied to protect against subsequent modification.
* @param offset the offset in <code>iv</code> where the IV starts.
* @exception IllegalArgumentException if <code>iv</code> is
* <code>null</code> or
* @param offset the offset in {@code iv} where the IV starts.
* @exception IllegalArgumentException if {@code iv} is
* {@code null} or
* {@code (iv.length - offset < 2 * (wordSize / 8))}
*/
public RC5ParameterSpec(int version, int rounds, int wordSize,
@ -164,12 +164,12 @@ public class RC5ParameterSpec implements AlgorithmParameterSpec {
* Tests for equality between the specified object and this
* object. Two RC5ParameterSpec objects are considered equal if their
* version numbers, number of rounds, word sizes, and IVs are equal.
* (Two IV references are considered equal if both are <tt>null</tt>.)
* (Two IV references are considered equal if both are {@code null}.)
*
* @param obj the object to test for equality with this object.
*
* @return true if the objects are considered equal, false if
* <code>obj</code> is null or otherwise.
* {@code obj} is null or otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) {

View File

@ -46,9 +46,9 @@ import sun.security.x509.X500Name;
/**
* PKCS7 as defined in RSA Laboratories PKCS7 Technical Note. Profile
* Supports only <tt>SignedData</tt> ContentInfo
* Supports only {@code SignedData} ContentInfo
* type, where to the type of data signed is plain Data.
* For signedData, <tt>crls</tt>, <tt>attributes</tt> and
* For signedData, {@code crls}, {@code attributes} and
* PKCS#6 Extended Certificates are not supported.
*
* @author Benjamin Renaud

View File

@ -180,7 +180,7 @@ public class SignerInfo implements DerEncoder {
/**
* DER encode this object onto an output stream.
* Implements the <code>DerEncoder</code> interface.
* Implements the {@code DerEncoder} interface.
*
* @param out
* the output stream on which to write the DER encoding.
@ -454,7 +454,7 @@ public class SignerInfo implements DerEncoder {
* Extracts a timestamp from a PKCS7 SignerInfo.
*
* Examines the signer's unsigned attributes for a
* <tt>signatureTimestampToken</tt> attribute. If present,
* {@code signatureTimestampToken} attribute. If present,
* then it is parsed to extract the date and time at which the
* timestamp was generated.
*

View File

@ -98,7 +98,7 @@ public class PKCS10Attributes implements DerEncoder {
/**
* Encode the attributes in DER form to the stream.
* Implements the <code>DerEncoder</code> interface.
* Implements the {@code DerEncoder} interface.
*
* @param out the OutputStream to marshal the contents to.
* @exception IOException on encoding errors.
@ -157,8 +157,8 @@ public class PKCS10Attributes implements DerEncoder {
/**
* Compares this PKCS10Attributes for equality with the specified
* object. If the <code>other</code> object is an
* <code>instanceof</code> <code>PKCS10Attributes</code>, then
* object. If the {@code other} object is an
* {@code instanceof PKCS10Attributes}, then
* all the entries are compared with the entries from this.
*
* @param other the object to test for equality with this PKCS10Attributes.
@ -205,10 +205,10 @@ public class PKCS10Attributes implements DerEncoder {
}
/**
* Returns a string representation of this <tt>PKCS10Attributes</tt> object
* Returns a string representation of this {@code PKCS10Attributes} object
* in the form of a set of entries, enclosed in braces and separated
* by the ASCII characters "<tt>,&nbsp;</tt>" (comma and space).
* <p>Overrides the <tt>toString</tt> method of <tt>Object</tt>.
* by the ASCII characters "<code>,&nbsp;</code>" (comma and space).
* <p>Overrides the {@code toString} method of {@code Object}.
*
* @return a string representation of this PKCS10Attributes.
*/

View File

@ -238,8 +238,8 @@ public class CRLExtensions {
/**
* Compares this CRLExtensions for equality with the specified
* object. If the <code>other</code> object is an
* <code>instanceof</code> <code>CRLExtensions</code>, then
* object. If the {@code other} object is an
* {@code instanceof} {@code CRLExtensions}, then
* all the entries are compared with the entries from this.
*
* @param other the object to test for equality with this CRLExtensions.
@ -286,10 +286,10 @@ public class CRLExtensions {
}
/**
* Returns a string representation of this <tt>CRLExtensions</tt> object
* Returns a string representation of this {@code CRLExtensions} object
* in the form of a set of entries, enclosed in braces and separated
* by the ASCII characters "<tt>,&nbsp;</tt>" (comma and space).
* <p>Overrides to <tt>toString</tt> method of <tt>Object</tt>.
* by the ASCII characters "<code>,&nbsp;</code>" (comma and space).
* <p>Overrides to {@code toString} method of {@code Object}.
*
* @return a string representation of this CRLExtensions.
*/

View File

@ -289,8 +289,8 @@ public class CertificateExtensions implements CertAttrSet<Extension> {
/**
* Compares this CertificateExtensions for equality with the specified
* object. If the <code>other</code> object is an
* <code>instanceof</code> <code>CertificateExtensions</code>, then
* object. If the {@code other} object is an
* {@code instanceof} {@code CertificateExtensions}, then
* all the entries are compared with the entries from this.
*
* @param other the object to test for equality with this
@ -339,10 +339,10 @@ public class CertificateExtensions implements CertAttrSet<Extension> {
}
/**
* Returns a string representation of this <tt>CertificateExtensions</tt>
* Returns a string representation of this {@code CertificateExtensions}
* object in the form of a set of entries, enclosed in braces and separated
* by the ASCII characters "<tt>,&nbsp;</tt>" (comma and space).
* <p>Overrides to <tt>toString</tt> method of <tt>Object</tt>.
* by the ASCII characters "<code>,&nbsp;</code>" (comma and space).
* <p>Overrides to {@code toString} method of {@code Object}.
*
* @return a string representation of this CertificateExtensions.
*/

View File

@ -296,7 +296,7 @@ public class Realm implements Cloneable {
*
* @param cRealm the initiating realm
* @param sRealm the target realm, not the same as cRealm
* @returns array of realms including at least cRealm as the first
* @return array of realms including at least cRealm as the first
* element
* @throws KrbException if the config does not contain a sub-stanza
* for cRealm in [capaths] or the sub-stanza does not contain
@ -347,7 +347,7 @@ public class Realm implements Cloneable {
* for a service in the target realm sRealm.
* @param cRealm the initiating realm
* @param sRealm the target realm, not the same as cRealm
* @returns array of realms including cRealm as the first element
* @return array of realms including cRealm as the first element
*/
private static String[] parseHierarchy(String cRealm, String sRealm) {

View File

@ -103,8 +103,8 @@ abstract class CramMD5Base {
/**
* Retrieves the negotiated property.
* This method can be called only after the authentication exchange has
* completed (i.e., when <tt>isComplete()</tt> returns true); otherwise, a
* <tt>SaslException</tt> is thrown.
* completed (i.e., when {@code isComplete()} returns true); otherwise, a
* {@code SaslException} is thrown.
*
* @return value of property; only QOP is applicable to CRAM-MD5.
* @exception IllegalStateException if this authentication exchange has not completed

View File

@ -141,8 +141,8 @@ final class ExternalClient implements SaslClient {
/**
* Retrieves the negotiated property.
* This method can be called only after the authentication exchange has
* completed (i.e., when <tt>isComplete()</tt> returns true); otherwise, a
* <tt>IllegalStateException</tt> is thrown.
* completed (i.e., when {@code isComplete()} returns true);
* otherwise, an {@code IllegalStateException} is thrown.
*
* @return null No property is applicable to this mechanism.
* @exception IllegalStateException if this authentication exchange

View File

@ -170,8 +170,8 @@ final class PlainClient implements SaslClient {
/**
* Retrieves the negotiated property.
* This method can be called only after the authentication exchange has
* completed (i.e., when <tt>isComplete()</tt> returns true); otherwise, a
* <tt>SaslException</tt> is thrown.
* completed (i.e., when {@code isComplete()} returns true); otherwise, a
* {@code SaslException} is thrown.
*
* @return value of property; only QOP is applicable to PLAIN.
* @exception IllegalStateException if this authentication exchange

View File

@ -567,7 +567,7 @@ final class DigestMD5Client extends DigestMD5Base implements SaslClient {
* username-value
* cnonce-value
* authzid-value
* @returns <tt>digest-response</tt> in a byte array
* @return {@code digest-response} in a byte array
* @throws SaslException if there is an error generating the
* response value or the cnonce value.
*/

View File

@ -31,38 +31,38 @@ import org.w3c.dom.Element;
* based on a shared secret computed from certain types of compatible public
* keys from both the sender and the recipient. Information from the originator
* to determine the secret is indicated by an optional OriginatorKeyInfo
* parameter child of an <code>AgreementMethod</code> element while that
* parameter child of an {@code AgreementMethod} element while that
* associated with the recipient is indicated by an optional RecipientKeyInfo. A
* shared key is derived from this shared secret by a method determined by the
* Key Agreement algorithm.
* <p>
* <b>Note:</b> XML Encryption does not provide an on-line key agreement
* negotiation protocol. The <code>AgreementMethod</code> element can be used by
* negotiation protocol. The {@code AgreementMethod} element can be used by
* the originator to identify the keys and computational procedure that were
* used to obtain a shared encryption key. The method used to obtain or select
* the keys or algorithm used for the agreement computation is beyond the scope
* of this specification.
* <p>
* The <code>AgreementMethod</code> element appears as the content of a
* <code>ds:KeyInfo</code> since, like other <code>ds:KeyInfo</code> children,
* it yields a key. This <code>ds:KeyInfo</code> is in turn a child of an
* <code>EncryptedData</code> or <code>EncryptedKey</code> element. The
* Algorithm attribute and KeySize child of the <code>EncryptionMethod</code>
* element under this <code>EncryptedData</code> or <code>EncryptedKey</code>
* The {@code AgreementMethod} element appears as the content of a
* {@code ds:KeyInfo} since, like other {@code ds:KeyInfo} children,
* it yields a key. This {@code ds:KeyInfo} is in turn a child of an
* {@code EncryptedData} or {@code EncryptedKey} element. The
* Algorithm attribute and KeySize child of the {@code EncryptionMethod}
* element under this {@code EncryptedData} or {@code EncryptedKey}
* element are implicit parameters to the key agreement computation. In cases
* where this <code>EncryptionMethod</code> algorithm <code>URI</code> is
* where this {@code EncryptionMethod} algorithm {@code URI} is
* insufficient to determine the key length, a KeySize MUST have been included.
* In addition, the sender may place a KA-Nonce element under
* <code>AgreementMethod</code> to assure that different keying material is
* {@code AgreementMethod} to assure that different keying material is
* generated even for repeated agreements using the same sender and recipient
* public keys.
* <p>
* If the agreed key is being used to wrap a key, then
* <code>AgreementMethod</code> would appear inside a <code>ds:KeyInfo</code>
* inside an <code>EncryptedKey</code> element.
* {@code AgreementMethod} would appear inside a {@code ds:KeyInfo}
* inside an {@code EncryptedKey} element.
* <p>
* The Schema for AgreementMethod is as follows:
* <xmp>
* <pre>{@code
* <element name="AgreementMethod" type="xenc:AgreementMethodType"/>
* <complexType name="AgreementMethodType" mixed="true">
* <sequence>
@ -74,15 +74,15 @@ import org.w3c.dom.Element;
* </sequence>
* <attribute name="Algorithm" type="anyURI" use="required"/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
public interface AgreementMethod {
/**
* Returns a <code>byte</code> array.
* @return a <code>byte</code> array.
* Returns a {@code byte} array.
* @return a {@code byte} array.
*/
byte[] getKANonce();
@ -93,30 +93,30 @@ public interface AgreementMethod {
void setKANonce(byte[] kanonce);
/**
* Returns additional information regarding the <code>AgreementMethod</code>.
* @return additional information regarding the <code>AgreementMethod</code>.
* Returns additional information regarding the {@code AgreementMethod}.
* @return additional information regarding the {@code AgreementMethod}.
*/
Iterator<Element> getAgreementMethodInformation();
/**
* Adds additional <code>AgreementMethod</code> information.
* Adds additional {@code AgreementMethod} information.
*
* @param info a <code>Element</code> that represents additional information
* @param info a {@code Element} that represents additional information
* specified by
* <xmp>
* <pre>{@code
* <any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
* </xmp>
* }</pre>
*/
void addAgreementMethodInformation(Element info);
/**
* Removes additional <code>AgreementMethod</code> information.
* Removes additional {@code AgreementMethod} information.
*
* @param info a <code>Element</code> that represents additional information
* @param info a {@code Element} that represents additional information
* specified by
* <xmp>
* <pre>{@code
* <any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
* </xmp>
* }</pre>
*/
void revoveAgreementMethodInformation(Element info);
@ -149,9 +149,9 @@ public interface AgreementMethod {
void setRecipientKeyInfo(KeyInfo keyInfo);
/**
* Returns the algorithm URI of this <code>CryptographicMethod</code>.
* Returns the algorithm URI of this {@code CryptographicMethod}.
*
* @return the algorithm URI of this <code>CryptographicMethod</code>
* @return the algorithm URI of this {@code CryptographicMethod}
*/
String getAlgorithm();
}

View File

@ -23,14 +23,14 @@
package com.sun.org.apache.xml.internal.security.encryption;
/**
* <code>CipherData</code> provides encrypted data. It must either contain the
* {@code CipherData} provides encrypted data. It must either contain the
* encrypted octet sequence as base64 encoded text of the
* <code>CipherValue</code> element, or provide a reference to an external
* {@code CipherValue} element, or provide a reference to an external
* location containing the encrypted octet sequence via the
* <code>CipherReference</code> element.
* {@code CipherReference} element.
* <p>
* The schema definition is as follows:
* <xmp>
* <pre>{@code
* <element name='CipherData' type='xenc:CipherDataType'/>
* <complexType name='CipherDataType'>
* <choice>
@ -38,7 +38,7 @@ package com.sun.org.apache.xml.internal.security.encryption;
* <element ref='xenc:CipherReference'/>
* </choice>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
@ -52,32 +52,32 @@ public interface CipherData {
/**
* Returns the type of encrypted data contained in the
* <code>CipherData</code>.
* {@code CipherData}.
*
* @return <code>VALUE_TYPE</code> if the encrypted data is contained as
* <code>CipherValue</code> or <code>REFERENCE_TYPE</code> if the
* encrypted data is contained as <code>CipherReference</code>.
* @return {@code VALUE_TYPE} if the encrypted data is contained as
* {@code CipherValue} or {@code REFERENCE_TYPE} if the
* encrypted data is contained as {@code CipherReference}.
*/
int getDataType();
/**
* Returns the cipher value as a base64 encoded <code>byte</code> array.
* Returns the cipher value as a base64 encoded {@code byte} array.
*
* @return the <code>CipherData</code>'s value.
* @return the {@code CipherData}'s value.
*/
CipherValue getCipherValue();
/**
* Sets the <code>CipherData</code>'s value.
* Sets the {@code CipherData}'s value.
*
* @param value the value of the <code>CipherData</code>.
* @param value the value of the {@code CipherData}.
* @throws XMLEncryptionException
*/
void setCipherValue(CipherValue value) throws XMLEncryptionException;
/**
* Returns a reference to an external location containing the encrypted
* octet sequence (<code>byte</code> array).
* octet sequence ({@code byte} array).
*
* @return the reference to an external location containing the encrypted
* octet sequence.
@ -85,7 +85,7 @@ public interface CipherData {
CipherReference getCipherReference();
/**
* Sets the <code>CipherData</code>'s reference.
* Sets the {@code CipherData}'s reference.
*
* @param reference an external location containing the encrypted octet sequence.
* @throws XMLEncryptionException

View File

@ -25,18 +25,18 @@ package com.sun.org.apache.xml.internal.security.encryption;
import org.w3c.dom.Attr;
/**
* <code>CipherReference</code> identifies a source which, when processed,
* {@code CipherReference} identifies a source which, when processed,
* yields the encrypted octet sequence.
* <p>
* The actual value is obtained as follows. The <code>CipherReference URI</code>
* The actual value is obtained as follows. The {@code CipherReference URI}
* contains an identifier that is dereferenced. Should the
* Transforms, the data resulting from dereferencing the <code>URI</code> is
* Transforms, the data resulting from dereferencing the {@code URI} is
* transformed as specified so as to yield the intended cipher value. For
* example, if the value is base64 encoded within an XML document; the
* transforms could specify an XPath expression followed by a base64 decoding so
* as to extract the octets.
* <p>
* The syntax of the <code>URI</code> and Transforms is similar to that of
* The syntax of the {@code URI} and Transforms is similar to that of
* [XML-DSIG]. However, there is a difference between signature and encryption
* processing. In [XML-DSIG] both generation and validation processing start
* with the same source data and perform that transform in the same order. In
@ -46,7 +46,7 @@ import org.w3c.dom.Attr;
* the &xenc; namespace.
* <p>
* The schema definition is as follows:
* <xmp>
* <pre>{@code
* <element name='CipherReference' type='xenc:CipherReferenceType'/>
* <complexType name='CipherReferenceType'>
* <sequence>
@ -54,15 +54,15 @@ import org.w3c.dom.Attr;
* </sequence>
* <attribute name='URI' type='anyURI' use='required'/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
public interface CipherReference {
/**
* Returns an <code>URI</code> that contains an identifier that should be
* Returns an {@code URI} that contains an identifier that should be
* dereferenced.
* @return an <code>URI</code> that contains an identifier that should be
* @return an {@code URI} that contains an identifier that should be
* dereferenced.
*/
String getURI();
@ -75,8 +75,8 @@ public interface CipherReference {
Attr getURIAsAttr();
/**
* Returns the <code>Transforms</code> that specifies how to transform the
* <code>URI</code> to yield the appropriate cipher value.
* Returns the {@code Transforms} that specifies how to transform the
* {@code URI} to yield the appropriate cipher value.
*
* @return the transform that specifies how to transform the reference to
* yield the intended cipher value.
@ -84,10 +84,10 @@ public interface CipherReference {
Transforms getTransforms();
/**
* Sets the <code>Transforms</code> that specifies how to transform the
* <code>URI</code> to yield the appropriate cipher value.
* Sets the {@code Transforms} that specifies how to transform the
* {@code URI} to yield the appropriate cipher value.
*
* @param transforms the set of <code>Transforms</code> that specifies how
* @param transforms the set of {@code Transforms} that specifies how
* to transform the reference to yield the intended cipher value.
*/
void setTransforms(Transforms transforms);

View File

@ -23,21 +23,21 @@
package com.sun.org.apache.xml.internal.security.encryption;
/**
* The <code>EncryptedData</code> element is the core element in the syntax. Not
* only does its <code>CipherData</code> child contain the encrypted data, but
* The {@code EncryptedData} element is the core element in the syntax. Not
* only does its {@code CipherData} child contain the encrypted data, but
* it's also the element that replaces the encrypted element, or serves as the
* new document root.
* <p>
* It's schema definition is as follows:
* <p>
* <xmp>
* <pre>{@code
* <element name='EncryptedData' type='xenc:EncryptedDataType'/>
* <complexType name='EncryptedDataType'>
* <complexContent>
* <extension base='xenc:EncryptedType'/>
* </complexContent>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/

View File

@ -23,17 +23,17 @@
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>
@ -46,7 +46,7 @@ package com.sun.org.apache.xml.internal.security.encryption;
* </extension>
* </complexContent>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
@ -55,31 +55,31 @@ 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.
*/
@ -87,19 +87,19 @@ public interface EncryptedKey extends EncryptedType {
/**
* 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();

View File

@ -25,13 +25,13 @@ package com.sun.org.apache.xml.internal.security.encryption;
import com.sun.org.apache.xml.internal.security.keys.KeyInfo;
/**
* EncryptedType is the abstract type from which <code>EncryptedData</code> and
* <code>EncryptedKey</code> are derived. While these two latter element types
* EncryptedType is the abstract type from which {@code EncryptedData} and
* {@code EncryptedKey} are derived. While these two latter element types
* are very similar with respect to their content models, a syntactical
* distinction is useful to processing.
* <p>
* Its schema definition is as follows:
* <xmp>
* <pre>{@code
* <complexType name='EncryptedType' abstract='true'>
* <sequence>
* <element name='EncryptionMethod' type='xenc:EncryptionMethodType'
@ -45,17 +45,17 @@ import com.sun.org.apache.xml.internal.security.keys.KeyInfo;
* <attribute name='MimeType' type='string' use='optional'/>
* <attribute name='Encoding' type='anyURI' use='optional'/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
public interface EncryptedType {
/**
* Returns a <code>String</code> providing for the standard method of
* Returns a {@code String} providing for the standard method of
* assigning an id to the element within the document context.
*
* @return the id for the <code>EncryptedType</code>.
* @return the id for the {@code EncryptedType}.
*/
String getId();
@ -67,11 +67,11 @@ public interface EncryptedType {
void setId(String id);
/**
* Returns an <code>URI</code> identifying type information about the
* Returns an {@code URI} identifying type information about the
* plaintext form of the encrypted content. While optional, this
* specification takes advantage of it for mandatory processing described in
* Processing Rules: Decryption (section 4.2). If the
* <code>EncryptedData</code> element contains data of Type 'element' or
* {@code EncryptedData} element contains data of Type 'element' or
* element 'content', and replaces that data in an XML document context, it
* is strongly recommended the Type attribute be provided. Without this
* information, the decryptor will be unable to automatically restore the
@ -85,13 +85,13 @@ public interface EncryptedType {
/**
* Sets the type.
*
* @param type an <code>URI</code> identifying type information about the
* @param type an {@code URI} identifying type information about the
* plaintext form of the encrypted content.
*/
void setType(String type);
/**
* Returns a <code>String</code> which describes the media type of the data
* Returns a {@code String} which describes the media type of the data
* which has been encrypted. The value of this attribute has values defined
* by [MIME]. For example, if the data that is encrypted is a base64 encoded
* PNG, the transfer Encoding may be specified as
@ -112,29 +112,29 @@ public interface EncryptedType {
/**
* Sets the mime type.
*
* @param type a <code>String</code> which describes the media type of the
* @param type a {@code String} which describes the media type of the
* data which has been encrypted.
*/
void setMimeType(String type);
/**
* Return an <code>URI</code> representing the encoding of the
* <code>EncryptedType</code>.
* Return an {@code URI} representing the encoding of the
* {@code EncryptedType}.
*
* @return the encoding of this <code>EncryptedType</code>.
* @return the encoding of this {@code EncryptedType}.
*/
String getEncoding();
/**
* Sets the <code>URI</code> representing the encoding of the
* <code>EncryptedType</code>.
* Sets the {@code URI} representing the encoding of the
* {@code EncryptedType}.
*
* @param encoding
*/
void setEncoding(String encoding);
/**
* Returns an <code>EncryptionMethod</code> that describes the encryption
* Returns an {@code EncryptionMethod} that describes the encryption
* algorithm applied to the cipher data. If the element is absent, the
* encryption algorithm must be known by the recipient or the decryption
* will fail.
@ -144,17 +144,17 @@ public interface EncryptedType {
EncryptionMethod getEncryptionMethod();
/**
* Sets the <code>EncryptionMethod</code> used to encrypt the cipher data.
* Sets the {@code EncryptionMethod} used to encrypt the cipher data.
*
* @param method the <code>EncryptionMethod</code>.
* @param method the {@code EncryptionMethod}.
*/
void setEncryptionMethod(EncryptionMethod method);
/**
* Returns the <code>ds:KeyInfo</code>, that carries information about the
* Returns the {@code ds:KeyInfo}, that carries information about the
* key used to encrypt the data. Subsequent sections of this specification
* define new elements that may appear as children of
* <code>ds:KeyInfo</code>.
* {@code ds:KeyInfo}.
*
* @return information about the key that encrypted the cipher data.
*/
@ -163,14 +163,14 @@ public interface EncryptedType {
/**
* Sets the encryption key information.
*
* @param info the <code>ds:KeyInfo</code>, that carries information about
* @param info the {@code ds:KeyInfo}, that carries information about
* the key used to encrypt the data.
*/
void setKeyInfo(KeyInfo info);
/**
* Returns the <code>CipherReference</code> that contains the
* <code>CipherValue</code> or <code>CipherReference</code> with the
* Returns the {@code CipherReference} that contains the
* {@code CipherValue} or {@code CipherReference} with the
* encrypted data.
*
* @return the cipher data for the encrypted type.
@ -179,16 +179,16 @@ public interface EncryptedType {
/**
* Returns additional information concerning the generation of the
* <code>EncryptedType</code>.
* {@code EncryptedType}.
*
* @return information relating to the generation of the
* <code>EncryptedType</code>.
* {@code EncryptedType}.
*/
EncryptionProperties getEncryptionProperties();
/**
* Sets the <code>EncryptionProperties</code> that supplies additional
* information about the generation of the <code>EncryptedType</code>.
* Sets the {@code EncryptionProperties} that supplies additional
* information about the generation of the {@code EncryptedType}.
*
* @param properties
*/

View File

@ -26,12 +26,12 @@ import java.util.Iterator;
import org.w3c.dom.Element;
/**
* <code>EncryptionMethod</code> describes the encryption algorithm applied to
* {@code EncryptionMethod} describes the encryption algorithm applied to
* the cipher data. If the element is absent, the encryption algorithm must be
* known by the recipient or the decryption will fail.
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <complexType name='EncryptionMethodType' mixed='true'>
* <sequence>
* <element name='KeySize' minOccurs='0' type='xenc:KeySizeType'/>
@ -40,7 +40,7 @@ import org.w3c.dom.Element;
* </sequence>
* <attribute name='Algorithm' type='anyURI' use='required'/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
@ -108,10 +108,10 @@ public interface EncryptionMethod {
/**
* Returns an iterator over all the additional elements contained in the
* <code>EncryptionMethod</code>.
* {@code EncryptionMethod}.
*
* @return an <code>Iterator</code> over all the additional information
* about the <code>EncryptionMethod</code>.
* @return an {@code Iterator} over all the additional information
* about the {@code EncryptionMethod}.
*/
Iterator<Element> getEncryptionMethodInformation();
@ -126,7 +126,7 @@ public interface EncryptionMethod {
* Removes encryption method information.
*
* @param information the information to remove from the
* <code>EncryptionMethod</code>.
* {@code EncryptionMethod}.
*/
void removeEncryptionMethodInformation(Element information);
}

View File

@ -25,15 +25,15 @@ package com.sun.org.apache.xml.internal.security.encryption;
import java.util.Iterator;
/**
* <code>EncryptionProperties</code> can hold additional information concerning
* the generation of the <code>EncryptedData</code> or
* <code>EncryptedKey</code>. This information is wraped int an
* <code>EncryptionProperty</code> element. Examples of additional information
* {@code EncryptionProperties} can hold additional information concerning
* the generation of the {@code EncryptedData} or
* {@code EncryptedKey}. This information is wraped int an
* {@code EncryptionProperty} element. Examples of additional information
* is e.g., a date/time stamp or the serial number of cryptographic hardware
* used during encryption).
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <element name='EncryptionProperties' type='xenc:EncryptionPropertiesType'/>
* <complexType name='EncryptionPropertiesType'>
* <sequence>
@ -41,14 +41,14 @@ import java.util.Iterator;
* </sequence>
* <attribute name='Id' type='ID' use='optional'/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
public interface EncryptionProperties {
/**
* Returns the <code>EncryptionProperties</code>' id.
* Returns the {@code EncryptionProperties}' id.
*
* @return the id.
*/
@ -62,23 +62,23 @@ public interface EncryptionProperties {
void setId(String id);
/**
* Returns an <code>Iterator</code> over all the
* <code>EncryptionPropterty</code> elements contained in this
* <code>EncryptionProperties</code>.
* Returns an {@code Iterator} over all the
* {@code EncryptionPropterty} elements contained in this
* {@code EncryptionProperties}.
*
* @return an <code>Iterator</code> over all the encryption properties.
* @return an {@code Iterator} over all the encryption properties.
*/
Iterator<EncryptionProperty> getEncryptionProperties();
/**
* Adds an <code>EncryptionProperty</code>.
* Adds an {@code EncryptionProperty}.
*
* @param property
*/
void addEncryptionProperty(EncryptionProperty property);
/**
* Removes the specified <code>EncryptionProperty</code>.
* Removes the specified {@code EncryptionProperty}.
*
* @param property
*/

View File

@ -27,16 +27,16 @@ import org.w3c.dom.Element;
/**
* Additional information items concerning the generation of the
* <code>EncryptedData</code> or <code>EncryptedKey</code> can be placed in an
* <code>EncryptionProperty</code> element (e.g., date/time stamp or the serial
* {@code EncryptedData} or {@code EncryptedKey} can be placed in an
* {@code EncryptionProperty} element (e.g., date/time stamp or the serial
* number of cryptographic hardware used during encryption). The Target
* attribute identifies the <code>EncryptedType</code> structure being
* attribute identifies the {@code EncryptedType} structure being
* described. anyAttribute permits the inclusion of attributes from the XML
* namespace to be included (i.e., <code>xml:space</code>,
* <code>xml:lang</code>, and <code>xml:base</code>).
* namespace to be included (i.e., {@code xml:space},
* {@code xml:lang}, and {@code xml:base}).
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <element name='EncryptionProperty' type='xenc:EncryptionPropertyType'/>
* <complexType name='EncryptionPropertyType' mixed='true'>
* <choice maxOccurs='unbounded'>
@ -46,17 +46,17 @@ import org.w3c.dom.Element;
* <attribute name='Id' type='ID' use='optional'/>
* <anyAttribute namespace="http://www.w3.org/XML/1998/namespace"/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
*/
public interface EncryptionProperty {
/**
* Returns the <code>EncryptedType</code> being described.
* Returns the {@code EncryptedType} being described.
*
* @return the <code>EncryptedType</code> being described by this
* <code>EncryptionProperty</code>.
* @return the {@code EncryptedType} being described by this
* {@code EncryptionProperty}.
*/
String getTarget();
@ -68,7 +68,7 @@ public interface EncryptionProperty {
void setTarget(String target);
/**
* Returns the id of the <CODE>EncryptionProperty</CODE>.
* Returns the id of the {@code EncryptionProperty}.
*
* @return the id.
*/
@ -82,7 +82,7 @@ public interface EncryptionProperty {
void setId(String id);
/**
* Returns the attribute's value in the <code>xml</code> namespace.
* Returns the attribute's value in the {@code xml} namespace.
*
* @param attribute
* @return the attribute's value.
@ -98,9 +98,9 @@ public interface EncryptionProperty {
void setAttribute(String attribute, String value);
/**
* Returns the properties of the <CODE>EncryptionProperty</CODE>.
* Returns the properties of the {@code EncryptionProperty}.
*
* @return an <code>Iterator</code> over all the additional encryption
* @return an {@code Iterator} over all the additional encryption
* information contained in this class.
*/
Iterator<Element> getEncryptionInformation();

View File

@ -26,55 +26,55 @@ import java.util.Iterator;
import org.w3c.dom.Element;
/**
* A wrapper for a pointer from a key value of an <code>EncryptedKey</code> to
* items encrypted by that key value (<code>EncryptedData</code> or
* <code>EncryptedKey</code> elements).
* A wrapper for a pointer from a key value of an {@code EncryptedKey} to
* items encrypted by that key value ({@code EncryptedData} or
* {@code EncryptedKey} elements).
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <complexType name='ReferenceType'>
* <sequence>
* <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
* </sequence>
* <attribute name='URI' type='anyURI' use='required'/>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
* @see ReferenceList
*/
public interface Reference {
/**
* Returns the <code>Element</code> tag name for this <code>Reference</code>.
* Returns the {@code Element} tag name for this {@code Reference}.
*
* @return the tag name of this <code>Reference</code>.
* @return the tag name of this {@code Reference}.
*/
String getType();
/**
* Returns a <code>URI</code> that points to an <code>Element</code> that
* Returns a {@code URI} that points to an {@code Element} that
* were encrypted using the key defined in the enclosing
* <code>EncryptedKey</code> element.
* {@code EncryptedKey} element.
*
* @return an Uniform Resource Identifier that qualifies an
* <code>EncryptedType</code>.
* {@code EncryptedType}.
*/
String getURI();
/**
* Sets a <code>URI</code> that points to an <code>Element</code> that
* Sets a {@code URI} that points to an {@code Element} that
* were encrypted using the key defined in the enclosing
* <code>EncryptedKey</code> element.
* {@code EncryptedKey} element.
*
* @param uri the Uniform Resource Identifier that qualifies an
* <code>EncryptedType</code>.
* {@code EncryptedType}.
*/
void setURI(String uri);
/**
* Returns an <code>Iterator</code> over all the child elements contained in
* this <code>Reference</code> that will aid the recipient in retrieving the
* <code>EncryptedKey</code> and/or <code>EncryptedData</code> elements.
* Returns an {@code Iterator} over all the child elements contained in
* this {@code Reference} that will aid the recipient in retrieving the
* {@code EncryptedKey} and/or {@code EncryptedData} elements.
* These could include information such as XPath transforms, decompression
* transforms, or information on how to retrieve the elements from a
* document storage facility.

View File

@ -25,12 +25,12 @@ package com.sun.org.apache.xml.internal.security.encryption;
import java.util.Iterator;
/**
* <code>ReferenceList</code> is an element that contains pointers from a key
* value of an <code>EncryptedKey</code> to items encrypted by that key value
* (<code>EncryptedData</code> or <code>EncryptedKey</code> elements).
* {@code ReferenceList} is an element that contains pointers from a key
* value of an {@code EncryptedKey} to items encrypted by that key value
* ({@code EncryptedData} or {@code EncryptedKey} elements).
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <element name='ReferenceList'>
* <complexType>
* <choice minOccurs='1' maxOccurs='unbounded'>
@ -39,7 +39,7 @@ import java.util.Iterator;
* </choice>
* </complexType>
* </element>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
* @see Reference
@ -56,54 +56,54 @@ public interface ReferenceList {
* Adds a reference to this reference list.
*
* @param reference the reference to add.
* @throws IllegalAccessException if the <code>Reference</code> is not an
* instance of <code>DataReference</code> or <code>KeyReference</code>.
* @throws IllegalAccessException if the {@code Reference} is not an
* instance of {@code DataReference} or {@code KeyReference}.
*/
void add(Reference reference);
/**
* Removes a reference from the <code>ReferenceList</code>.
* Removes a reference from the {@code ReferenceList}.
*
* @param reference the reference to remove.
*/
void remove(Reference reference);
/**
* Returns the size of the <code>ReferenceList</code>.
* Returns the size of the {@code ReferenceList}.
*
* @return the size of the <code>ReferenceList</code>.
* @return the size of the {@code ReferenceList}.
*/
int size();
/**
* Indicates if the <code>ReferenceList</code> is empty.
* Indicates if the {@code ReferenceList} is empty.
*
* @return <code><b>true</b></code> if the <code>ReferenceList</code> is
* empty, else <code><b>false</b></code>.
* @return <b>{@code true}</b> if the {@code ReferenceList} is
* empty, else <b>{@code false}</b>.
*/
boolean isEmpty();
/**
* Returns an <code>Iterator</code> over all the <code>Reference</code>s
* contained in this <code>ReferenceList</code>.
* Returns an {@code Iterator} over all the {@code Reference}s
* contained in this {@code ReferenceList}.
*
* @return Iterator.
*/
Iterator<Reference> getReferences();
/**
* <code>DataReference</code> factory method. Returns a
* <code>DataReference</code>.
* {@code DataReference} factory method. Returns a
* {@code DataReference}.
* @param uri
* @return a <code>DataReference</code>.
* @return a {@code DataReference}.
*/
Reference newDataReference(String uri);
/**
* <code>KeyReference</code> factory method. Returns a
* <code>KeyReference</code>.
* {@code KeyReference} factory method. Returns a
* {@code KeyReference}.
* @param uri
* @return a <code>KeyReference</code>.
* @return a {@code KeyReference}.
*/
Reference newKeyReference(String uri);
}

View File

@ -23,16 +23,16 @@
package com.sun.org.apache.xml.internal.security.encryption;
/**
* A container for <code>ds:Transform</code>s.
* A container for {@code ds:Transform}s.
* <p>
* It is defined as follows:
* <xmp>
* <pre>{@code
* <complexType name='TransformsType'>
* <sequence>
* <element ref='ds:Transform' maxOccurs='unbounded'/>
* </sequence>
* </complexType>
* </xmp>
* }</pre>
*
* @author Axl Mattheus
* @see com.sun.org.apache.xml.internal.security.encryption.CipherReference

View File

@ -33,8 +33,8 @@ import java.io.PrintWriter;
/**
* Indicates an exceptional condition thrown by a {@link KeySelector}.
*
* <p>A <code>KeySelectorException</code> can contain a cause: another
* throwable that caused this <code>KeySelectorException</code> to get thrown.
* <p>A {@code KeySelectorException} can contain a cause: another
* throwable that caused this {@code KeySelectorException} to get thrown.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
@ -46,7 +46,7 @@ public class KeySelectorException extends Exception {
/**
* The throwable that caused this exception to get thrown, or
* <code>null</code> if this exception was not caused by another throwable
* {@code null} if this exception was not caused by another throwable
* or if the causative throwable is unknown.
*
* @serial
@ -54,15 +54,15 @@ public class KeySelectorException extends Exception {
private Throwable cause;
/**
* Constructs a new <code>KeySelectorException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code KeySelectorException} with
* {@code null} as its detail message.
*/
public KeySelectorException() {
super();
}
/**
* Constructs a new <code>KeySelectorException</code> with the specified
* Constructs a new {@code KeySelectorException} with the specified
* detail message.
*
* @param message the detail message
@ -72,14 +72,14 @@ public class KeySelectorException extends Exception {
}
/**
* Constructs a new <code>KeySelectorException</code> with the
* Constructs a new {@code KeySelectorException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public KeySelectorException(String message, Throwable cause) {
@ -88,13 +88,13 @@ public class KeySelectorException extends Exception {
}
/**
* Constructs a new <code>KeySelectorException</code> with the specified
* Constructs a new {@code KeySelectorException} with the specified
* cause and a detail message of
* <code>(cause==null ? null : cause.toString())</code>
* {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
* <code>cause</code>).
* {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public KeySelectorException(Throwable cause) {
@ -103,20 +103,20 @@ public class KeySelectorException extends Exception {
}
/**
* Returns the cause of this <code>KeySelectorException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code KeySelectorException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>KeySelectorException</code> to get thrown.)
* {@code KeySelectorException} to get thrown.)
*
* @return the cause of this <code>KeySelectorException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code KeySelectorException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>KeySelectorException</code>, its backtrace and
* Prints this {@code KeySelectorException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -125,10 +125,10 @@ public class KeySelectorException extends Exception {
}
/**
* Prints this <code>KeySelectorException</code>, its backtrace and
* Prints this {@code KeySelectorException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -136,10 +136,10 @@ public class KeySelectorException extends Exception {
}
/**
* Prints this <code>KeySelectorException</code>, its backtrace and
* Prints this {@code KeySelectorException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -39,8 +39,8 @@ import javax.xml.crypto.dsig.keyinfo.KeyInfoFactory;
* Indicates an exceptional condition that occurred during the XML
* marshalling or unmarshalling process.
*
* <p>A <code>MarshalException</code> can contain a cause: another
* throwable that caused this <code>MarshalException</code> to get thrown.
* <p>A {@code MarshalException} can contain a cause: another
* throwable that caused this {@code MarshalException} to get thrown.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
@ -62,15 +62,15 @@ public class MarshalException extends Exception {
private Throwable cause;
/**
* Constructs a new <code>MarshalException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code MarshalException} with
* {@code null} as its detail message.
*/
public MarshalException() {
super();
}
/**
* Constructs a new <code>MarshalException</code> with the specified
* Constructs a new {@code MarshalException} with the specified
* detail message.
*
* @param message the detail message
@ -80,14 +80,14 @@ public class MarshalException extends Exception {
}
/**
* Constructs a new <code>MarshalException</code> with the
* Constructs a new {@code MarshalException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public MarshalException(String message, Throwable cause) {
@ -96,12 +96,11 @@ public class MarshalException extends Exception {
}
/**
* Constructs a new <code>MarshalException</code> with the specified cause
* and a detail message of <code>(cause==null ? null : cause.toString())
* </code> (which typically contains the class and detail message of
* <code>cause</code>).
* Constructs a new {@code MarshalException} with the specified cause
* and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public MarshalException(Throwable cause) {
@ -110,20 +109,20 @@ public class MarshalException extends Exception {
}
/**
* Returns the cause of this <code>MarshalException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code MarshalException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>MarshalException</code> to get thrown.)
* {@code MarshalException} to get thrown.)
*
* @return the cause of this <code>MarshalException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code MarshalException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>MarshalException</code>, its backtrace and
* Prints this {@code MarshalException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -132,10 +131,10 @@ public class MarshalException extends Exception {
}
/**
* Prints this <code>MarshalException</code>, its backtrace and
* Prints this {@code MarshalException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -143,10 +142,10 @@ public class MarshalException extends Exception {
}
/**
* Prints this <code>MarshalException</code>, its backtrace and
* Prints this {@code MarshalException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -39,8 +39,8 @@ import javax.xml.crypto.dsig.keyinfo.KeyInfoFactory;
* This exception is thrown when a particular XML mechanism is requested but
* is not available in the environment.
*
* <p>A <code>NoSuchMechanismException</code> can contain a cause: another
* throwable that caused this <code>NoSuchMechanismException</code> to get
* <p>A {@code NoSuchMechanismException} can contain a cause: another
* throwable that caused this {@code NoSuchMechanismException} to get
* thrown.
*
* @author Sean Mullan
@ -63,15 +63,15 @@ public class NoSuchMechanismException extends RuntimeException {
private Throwable cause;
/**
* Constructs a new <code>NoSuchMechanismException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code NoSuchMechanismException} with
* {@code null} as its detail message.
*/
public NoSuchMechanismException() {
super();
}
/**
* Constructs a new <code>NoSuchMechanismException</code> with the
* Constructs a new {@code NoSuchMechanismException} with the
* specified detail message.
*
* @param message the detail message
@ -81,14 +81,14 @@ public class NoSuchMechanismException extends RuntimeException {
}
/**
* Constructs a new <code>NoSuchMechanismException</code> with the
* Constructs a new {@code NoSuchMechanismException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public NoSuchMechanismException(String message, Throwable cause) {
@ -97,12 +97,12 @@ public class NoSuchMechanismException extends RuntimeException {
}
/**
* Constructs a new <code>NoSuchMechanismException</code> with the
* Constructs a new {@code NoSuchMechanismException} with the
* specified cause and a detail message of
* <code>(cause==null ? null : cause.toString())</code> (which typically
* contains the class and detail message of <code>cause</code>).
* {@code (cause==null ? null : cause.toString())} (which typically
* contains the class and detail message of {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public NoSuchMechanismException(Throwable cause) {
@ -111,20 +111,20 @@ public class NoSuchMechanismException extends RuntimeException {
}
/**
* Returns the cause of this <code>NoSuchMechanismException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code NoSuchMechanismException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>NoSuchMechanismException</code> to get thrown.)
* {@code NoSuchMechanismException} to get thrown.)
*
* @return the cause of this <code>NoSuchMechanismException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code NoSuchMechanismException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>NoSuchMechanismException</code>, its backtrace and
* Prints this {@code NoSuchMechanismException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -133,10 +133,10 @@ public class NoSuchMechanismException extends RuntimeException {
}
/**
* Prints this <code>NoSuchMechanismException</code>, its backtrace and
* Prints this {@code NoSuchMechanismException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -144,10 +144,10 @@ public class NoSuchMechanismException extends RuntimeException {
}
/**
* Prints this <code>NoSuchMechanismException</code>, its backtrace and
* Prints this {@code NoSuchMechanismException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -35,8 +35,8 @@ import javax.xml.crypto.dsig.keyinfo.RetrievalMethod;
* Indicates an exceptional condition thrown while dereferencing a
* {@link URIReference}.
*
* <p>A <code>URIReferenceException</code> can contain a cause: another
* throwable that caused this <code>URIReferenceException</code> to get thrown.
* <p>A {@code URIReferenceException} can contain a cause: another
* throwable that caused this {@code URIReferenceException} to get thrown.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
@ -60,15 +60,15 @@ public class URIReferenceException extends Exception {
private URIReference uriReference;
/**
* Constructs a new <code>URIReferenceException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code URIReferenceException} with
* {@code null} as its detail message.
*/
public URIReferenceException() {
super();
}
/**
* Constructs a new <code>URIReferenceException</code> with the specified
* Constructs a new {@code URIReferenceException} with the specified
* detail message.
*
* @param message the detail message
@ -78,14 +78,14 @@ public class URIReferenceException extends Exception {
}
/**
* Constructs a new <code>URIReferenceException</code> with the
* Constructs a new {@code URIReferenceException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public URIReferenceException(String message, Throwable cause) {
@ -94,19 +94,19 @@ public class URIReferenceException extends Exception {
}
/**
* Constructs a new <code>URIReferenceException</code> with the
* specified detail message, cause and <code>URIReference</code>.
* Constructs a new {@code URIReferenceException} with the
* specified detail message, cause and {@code URIReference}.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
* @param uriReference the <code>URIReference</code> that was being
* @param uriReference the {@code URIReference} that was being
* dereferenced when the error was encountered
* @throws NullPointerException if <code>uriReference</code> is
* <code>null</code>
* @throws NullPointerException if {@code uriReference} is
* {@code null}
*/
public URIReferenceException(String message, Throwable cause,
URIReference uriReference) {
@ -118,12 +118,12 @@ public class URIReferenceException extends Exception {
}
/**
* Constructs a new <code>URIReferenceException</code> with the specified
* cause and a detail message of <code>(cause==null ? null :
* cause.toString())</code> (which typically contains the class and detail
* message of <code>cause</code>).
* Constructs a new {@code URIReferenceException} with the specified
* cause and a detail message of {@code (cause==null ? null :
* cause.toString())} (which typically contains the class and detail
* message of {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public URIReferenceException(Throwable cause) {
@ -132,31 +132,31 @@ public class URIReferenceException extends Exception {
}
/**
* Returns the <code>URIReference</code> that was being dereferenced
* Returns the {@code URIReference} that was being dereferenced
* when the exception was thrown.
*
* @return the <code>URIReference</code> that was being dereferenced
* when the exception was thrown, or <code>null</code> if not specified
* @return the {@code URIReference} that was being dereferenced
* when the exception was thrown, or {@code null} if not specified
*/
public URIReference getURIReference() {
return uriReference;
}
/**
* Returns the cause of this <code>URIReferenceException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code URIReferenceException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>URIReferenceException</code> to get thrown.)
* {@code URIReferenceException} to get thrown.)
*
* @return the cause of this <code>URIReferenceException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code URIReferenceException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>URIReferenceException</code>, its backtrace and
* Prints this {@code URIReferenceException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -165,10 +165,10 @@ public class URIReferenceException extends Exception {
}
/**
* Prints this <code>URIReferenceException</code>, its backtrace and
* Prints this {@code URIReferenceException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -176,10 +176,10 @@ public class URIReferenceException extends Exception {
}
/**
* Prints this <code>URIReferenceException</code>, its backtrace and
* Prints this {@code URIReferenceException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -34,8 +34,8 @@ import java.io.PrintWriter;
* Indicates an exceptional condition that occurred while executing a
* transform algorithm.
*
* <p>A <code>TransformException</code> can contain a cause: another
* throwable that caused this <code>TransformException</code> to get thrown.
* <p>A {@code TransformException} can contain a cause: another
* throwable that caused this {@code TransformException} to get thrown.
*
* @see Transform#transform
* @author Sean Mullan
@ -56,15 +56,15 @@ public class TransformException extends Exception {
private Throwable cause;
/**
* Constructs a new <code>TransformException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code TransformException} with
* {@code null} as its detail message.
*/
public TransformException() {
super();
}
/**
* Constructs a new <code>TransformException</code> with the specified
* Constructs a new {@code TransformException} with the specified
* detail message.
*
* @param message the detail message
@ -74,14 +74,14 @@ public class TransformException extends Exception {
}
/**
* Constructs a new <code>TransformException</code> with the
* Constructs a new {@code TransformException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public TransformException(String message, Throwable cause) {
@ -90,13 +90,13 @@ public class TransformException extends Exception {
}
/**
* Constructs a new <code>TransformException</code> with the specified
* Constructs a new {@code TransformException} with the specified
* cause and a detail message of
* <code>(cause==null ? null : cause.toString())</code>
* {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
* <code>cause</code>).
* {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public TransformException(Throwable cause) {
@ -105,20 +105,20 @@ public class TransformException extends Exception {
}
/**
* Returns the cause of this <code>TransformException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code TransformException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>TransformException</code> to get thrown.)
* {@code TransformException} to get thrown.)
*
* @return the cause of this <code>TransformException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code TransformException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>TransformException</code>, its backtrace and
* Prints this {@code TransformException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -129,10 +129,10 @@ public class TransformException extends Exception {
}
/**
* Prints this <code>TransformException</code>, its backtrace and
* Prints this {@code TransformException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -142,10 +142,10 @@ public class TransformException extends Exception {
}
/**
* Prints this <code>TransformException</code>, its backtrace and
* Prints this {@code TransformException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -34,8 +34,8 @@ import java.io.PrintWriter;
* Indicates an exceptional condition that occurred during the XML
* signature generation or validation process.
*
* <p>An <code>XMLSignatureException</code> can contain a cause: another
* throwable that caused this <code>XMLSignatureException</code> to get thrown.
* <p>An {@code XMLSignatureException} can contain a cause: another
* throwable that caused this {@code XMLSignatureException} to get thrown.
*
* @since 1.6
*/
@ -53,15 +53,15 @@ public class XMLSignatureException extends Exception {
private Throwable cause;
/**
* Constructs a new <code>XMLSignatureException</code> with
* <code>null</code> as its detail message.
* Constructs a new {@code XMLSignatureException} with
* {@code null} as its detail message.
*/
public XMLSignatureException() {
super();
}
/**
* Constructs a new <code>XMLSignatureException</code> with the specified
* Constructs a new {@code XMLSignatureException} with the specified
* detail message.
*
* @param message the detail message
@ -71,14 +71,14 @@ public class XMLSignatureException extends Exception {
}
/**
* Constructs a new <code>XMLSignatureException</code> with the
* Constructs a new {@code XMLSignatureException} with the
* specified detail message and cause.
* <p>Note that the detail message associated with
* <code>cause</code> is <i>not</i> automatically incorporated in
* {@code cause} is <i>not</i> automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public XMLSignatureException(String message, Throwable cause) {
@ -87,13 +87,13 @@ public class XMLSignatureException extends Exception {
}
/**
* Constructs a new <code>XMLSignatureException</code> with the specified
* Constructs a new {@code XMLSignatureException} with the specified
* cause and a detail message of
* <code>(cause==null ? null : cause.toString())</code>
* {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
* <code>cause</code>).
* {@code cause}).
*
* @param cause the cause (A <tt>null</tt> value is permitted, and
* @param cause the cause (A {@code null} value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public XMLSignatureException(Throwable cause) {
@ -102,20 +102,20 @@ public class XMLSignatureException extends Exception {
}
/**
* Returns the cause of this <code>XMLSignatureException</code> or
* <code>null</code> if the cause is nonexistent or unknown. (The
* Returns the cause of this {@code XMLSignatureException} or
* {@code null} if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* <code>XMLSignatureException</code> to get thrown.)
* {@code XMLSignatureException} to get thrown.)
*
* @return the cause of this <code>XMLSignatureException</code> or
* <code>null</code> if the cause is nonexistent or unknown.
* @return the cause of this {@code XMLSignatureException} or
* {@code null} if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this <code>XMLSignatureException</code>, its backtrace and
* Prints this {@code XMLSignatureException}, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
@ -126,10 +126,10 @@ public class XMLSignatureException extends Exception {
}
/**
* Prints this <code>XMLSignatureException</code>, its backtrace and
* Prints this {@code XMLSignatureException}, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s <code>PrintStream</code> to use for output
* @param s {@code PrintStream} to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
@ -139,10 +139,10 @@ public class XMLSignatureException extends Exception {
}
/**
* Prints this <code>XMLSignatureException</code>, its backtrace and
* Prints this {@code XMLSignatureException}, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s <code>PrintWriter</code> to use for output
* @param s {@code PrintWriter} to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);

View File

@ -474,7 +474,7 @@ class NativeCipher extends CipherSpi {
/**
* calls ucrypto_encrypt_update(...) or ucrypto_decrypt_update(...)
* @returns the length of output or if negative, an error status code
* @return the length of output or if negative, an error status code
*/
private native static int nativeUpdate(long pContext, boolean encrypt,
byte[] in, int inOfs, int inLen,
@ -482,7 +482,7 @@ class NativeCipher extends CipherSpi {
/**
* calls ucrypto_encrypt_final(...) or ucrypto_decrypt_final(...)
* @returns the length of output or if negative, an error status code
* @return the length of output or if negative, an error status code
*/
native static int nativeFinal(long pContext, boolean encrypt,
byte[] out, int outOfs);

View File

@ -377,7 +377,7 @@ public class NativeRSACipher extends CipherSpi {
/**
* calls ucrypto_encrypt(...) or ucrypto_decrypt(...)
* @returns the length of output or an negative error status code
* @return the length of output or an negative error status code
*/
private native static int nativeAtomic(int mech, boolean encrypt,
long keyValue, int keyLength,

View File

@ -353,20 +353,20 @@ class NativeRSASignature extends SignatureSpi {
/**
* calls ucrypto_sign_update(...) or ucrypto_verify_update(...)
* @returns an error status code (0 means SUCCESS)
* @return an error status code (0 means SUCCESS)
*/
private native static int nativeUpdate(long pContext, boolean sign,
byte[] in, int inOfs, int inLen);
/**
* calls ucrypto_sign_update(...) or ucrypto_verify_update(...)
* @returns an error status code (0 means SUCCESS)
* @return an error status code (0 means SUCCESS)
*/
private native static int nativeUpdate(long pContext, boolean sign,
long pIn, int inLen);
/**
* calls ucrypto_sign_final(...) or ucrypto_verify_final(...)
* @returns the length of signature bytes or verification status.
* @return the length of signature bytes or verification status.
* If negative, it indicates an error status code
*/
private native static int nativeFinal(long pContext, boolean sign,

View File

@ -24,9 +24,9 @@
*/
/**
* This package comprises the interfaces and classes used to define the
* signing mechanism used by the <tt>jarsigner</tt> tool.
* signing mechanism used by the {@code jarsigner} tool.
* <p>
* Clients may override the default signing mechanism of the <tt>jarsigner</tt>
* Clients may override the default signing mechanism of the {@code jarsigner}
* tool by supplying an alternative implementation of
* {@link com.sun.jarsigner.ContentSigner}.
*

View File

@ -141,9 +141,9 @@ public final class TimestampedSigner extends ContentSigner {
/**
* Examine the certificate for a Subject Information Access extension
* (<a href="http://tools.ietf.org/html/rfc5280">RFC 5280</a>).
* The extension's <tt>accessMethod</tt> field should contain the object
* The extension's {@code accessMethod} field should contain the object
* identifier defined for timestamping: 1.3.6.1.5.5.7.48.3 and its
* <tt>accessLocation</tt> field should contain an HTTP or HTTPS URL.
* {@code accessLocation} field should contain an HTTP or HTTPS URL.
*
* @param tsaCertificate An X.509 certificate for the TSA.
* @return An HTTP or HTTPS URI or null if none was found.