Resolves: 380215

Summary:  Fixed javadoc comments that were causing warnings at build time.


git-svn-id: svn://10.0.0.236/trunk@226263 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
nkinder%redhat.com
2007-05-10 17:35:41 +00:00
parent ed1eb8cd6e
commit 7aa6718020
50 changed files with 40 additions and 76 deletions

View File

@@ -150,7 +150,6 @@ public class LDAPGetEntries extends LDAPBasePropertySupport implements Serializa
* @param scope one of LDAPConnection.SCOPE_BASE,
* LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE
* @param filter search filter
* @param attribute name of property to return values for
* @return Array of values for the property
*/
public String[] getEntries( String host,

View File

@@ -96,7 +96,7 @@ public class LDAPIsMember extends LDAPBasePropertySupport
* @param port port number
* @param dn fully qualified distinguished name to authenticate
* @param password password for authenticating the dn
* @param group distinguished name of the group
* @param theGroup distinguished name of the group
*/
public LDAPIsMember( String host, int port,
String dn, String password, String theGroup ) {
@@ -312,7 +312,6 @@ public class LDAPIsMember extends LDAPBasePropertySupport
/**
* Checks if an entity (specified by distinguished name) is a
* member of a particular group (specified by distinguished name)
* @return true if the specified member belongs to the group
*/
public void isMember(ActionEvent e) {
isMember();

View File

@@ -150,7 +150,7 @@ public abstract interface SaslClient {
* done by the client object.
*
* This method can only be called if isComplete() returns true.
* @param is The original output stream for writing to the server.
* @param os The original output stream for writing to the server.
* @return An output stream for writing to the server, which
* may include processing the original stream.
* @exception IOException If the authentication exchange has not completed

View File

@@ -129,7 +129,7 @@ public class SaslException extends java.io.IOException {
* Prints this exception's stack trace to a print writer.
* If this exception has a root exception; the stack trace of the
* root exception is printed to the print writer instead.
* @param ps The non-null print writer to which to print.
* @param pw The non-null print writer to which to print.
*/
public void printStackTrace(java.io.PrintWriter pw) {
if ( exception != null ) {

View File

@@ -125,7 +125,7 @@ public class SaslExternal implements SaslClient {
* done by the client object.
*
* This method can only be called if isComplete() returns true.
* @param is The original output stream for writing to the server.
* @param os The original output stream for writing to the server.
* @return An output stream for writing to the server, which
* may include processing the original stream. For this class, the
* input parameter is always returned.

View File

@@ -55,7 +55,6 @@ public interface LDAPAsynchronousConnection {
* attributes of the new entry
* @param listener handler for messages returned from a server in response
* to this request. If it is null, a listener object is created internally.
* @param cons constraints specific to the operation
* @return LDAPSearchListener handler for messages returned from a server
* in response to this request.
* @exception LDAPException Failed to send request.

View File

@@ -158,7 +158,7 @@ public class LDAPCompareAttrNames
* <CODE>LDAPException</CODE> is thrown.
* <P>
*
* @param attribute array of the attribute names to use for comparisons
* @param attributes array of the attribute names to use for comparisons
* @param ascendingFlags array of boolean values specifying ascending
* or descending order to use for each attribute name. If
* <CODE>true</CODE>, the attributes are sorted in ascending order.

View File

@@ -3319,7 +3319,7 @@ public class LDAPConnection
* argument, an <CODE>LDAPException</CODE> will be thrown.
* <P>
*
* @param DN current distinguished name of the entry
* @param dn current distinguished name of the entry
* @param newRDN new relative distinguished name for the entry (for example,
* "cn=newName")
* @param newParentDN if not null, the distinguished name for the
@@ -3424,7 +3424,6 @@ public class LDAPConnection
* attributes of the new entry
* @param listener handler for messages returned from a server in response
* to this request. If it is null, a listener object is created internally.
* @param cons constraints specific to the operation
* @return LDAPResponseListener handler for messages returned from a server
* in response to this request.
* @exception LDAPException Failed to send request.

View File

@@ -73,7 +73,6 @@ public interface LDAPEntryComparator {
* argument.
* <P>
*
* @version 1.0
* @see netscape.ldap.LDAPCompareAttrNames
* @see netscape.ldap.LDAPSearchResults#sort
*/

View File

@@ -491,8 +491,6 @@ public abstract class LDAPSchemaElement implements java.io.Serializable {
* values of the "attributetypes" attribute are attribute type
* descriptions in this format.
* <P>
* @param quotingBug <CODE>true</CODE> if single quotes are to be
* supplied around the SYNTAX and SUP value
* @return a formatted String for defining a schema element.
*/
public String getValue() {

View File

@@ -67,7 +67,6 @@ public interface LDAPTraceWriter {
*
* @param msg An incoming or outgoing LDAP message
*
* @version 1.0
* @see netscape.ldap.LDAPConnection#setProperty(java.lang.String, java.lang.Object)
*/
public void write (String msg);

View File

@@ -599,7 +599,7 @@ public class LDAPUrl implements java.io.Serializable {
* Sets the socket factory to be used for ldaps:// URLs.
* Overrides the default factory assigned by the LDAPUrl
* class.
* @param the socket factory to be used for ldaps:// URLs
* @param factory the socket factory to be used for ldaps:// URLs
* @see netscape.ldap.LDAPUrl#getSocketFactory
*/
public static void setSocketFactory(LDAPSocketFactory factory) {

View File

@@ -422,7 +422,7 @@ public interface LDAPv2 {
/**
* Modifies the attributes of a directory entry.
* @param DN distinguished name identifying the entry to modify
* @param mod list of the modifications to make
* @param mods list of the modifications to make
* @exception LDAPException Failed to modify the specified entry.
*/
public void modify (String DN, LDAPModificationSet mods ) throws LDAPException;
@@ -430,7 +430,7 @@ public interface LDAPv2 {
/**
* Modifies the attributes of a directory entry.
* @param DN distinguished name identifying the entry to modify
* @param mod list of the modifications to make
* @param mods list of the modifications to make
* @param cons the constraints set for the modify operation
* @exception LDAPException Failed to modify the specified entry.
*/

View File

@@ -91,7 +91,6 @@ public class BERAny extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.ANY;

View File

@@ -242,7 +242,6 @@ public class BERBitString extends BERElement {
/**
* Gets the bitstring value.
* @param element type
*/
public BitSet getValue() {
return m_value;
@@ -258,7 +257,6 @@ public class BERBitString extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.BITSTRING;

View File

@@ -106,7 +106,6 @@ public class BERBoolean extends BERElement {
/**
* Gets the boolean value.
* @param element type
*/
public boolean getValue() {
return m_value;
@@ -114,7 +113,6 @@ public class BERBoolean extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.BOOLEAN;

View File

@@ -60,7 +60,7 @@ public abstract class BERCharacterString extends BERElement {
/**
* Constructs a character string element containing buffer.
* @param buffer a string value
* @param string a string value
*/
public BERCharacterString(String string) {
m_value = string;
@@ -177,7 +177,6 @@ public abstract class BERCharacterString extends BERElement {
/**
* Gets the element value.
* @param element value
*/
public String getValue() {
return m_value;
@@ -185,7 +184,6 @@ public abstract class BERCharacterString extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public abstract int getType();

View File

@@ -92,7 +92,6 @@ public class BERChoice extends BERElement {
/**
* Gets the value of the chosen type.
* @param element type
*/
public BERElement getValue() {
return m_value;
@@ -100,7 +99,6 @@ public class BERChoice extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.CHOICE;

View File

@@ -95,7 +95,6 @@ public abstract class BERConstruct extends BERElement {
/**
* Adds an element to the list.
* @return BER encoding of the element.
*/
public void addElement(BERElement element) {
m_elements.addElement(element);
@@ -138,7 +137,6 @@ public abstract class BERConstruct extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public abstract int getType();

View File

@@ -209,7 +209,6 @@ public abstract class BERElement implements Serializable {
* Uses shortform whenever possible.
* @param stream output stream to write to
* @param num_content_octets value to be encode into length octets
* @return number of bytes sent to stream.
* @exception IOException failed to read octets
*/
public static void sendDefiniteLength(OutputStream stream,
@@ -320,7 +319,6 @@ public abstract class BERElement implements Serializable {
/**
* Sends the BER encoding directly to a stream.
* @param stream output stream
* @return bytes written to stream.
*/
public abstract void write(OutputStream stream) throws IOException;

View File

@@ -82,7 +82,6 @@ public class BEREnumerated extends BERIntegral {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.ENUMERATED;

View File

@@ -87,7 +87,6 @@ public class BERInteger extends BERIntegral {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.INTEGER;

View File

@@ -58,7 +58,7 @@ public class BERNumericString extends BERCharacterString {
/**
* Constructs a numeric string element from a string
* @param buffer string with value of element
* @param string string with value of element
*/
public BERNumericString(String string) {
m_value = string;

View File

@@ -173,7 +173,6 @@ public class BEROctetString extends BERElement {
/**
* Writes BER to stream
* @return number of bytes written to stream.
* @exception IOException failed to write
*/
public void write(OutputStream stream) throws IOException {
@@ -188,7 +187,6 @@ public class BEROctetString extends BERElement {
/**
* Gets the element value.
* @param element value
*/
public byte[] getValue() {
return m_value;
@@ -196,7 +194,6 @@ public class BEROctetString extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.OCTETSTRING;

View File

@@ -58,7 +58,7 @@ public class BERPrintableString extends BERCharacterString {
/**
* Constructs a printable string element containing buffer.
* @param buffer string value
* @param string string value
*/
public BERPrintableString(String string) {
m_value = string;

View File

@@ -139,7 +139,6 @@ public class BERUTCTime extends BERElement {
private byte[] byte_buf;
/**
* Writes BER to a stream.
* @return number of bytes written to stream.
* @exception IOException failed to write
*/
public void write(OutputStream stream) throws IOException {
@@ -159,7 +158,6 @@ public class BERUTCTime extends BERElement {
/**
* Gets the element value.
* @param element value
*/
public String getValue() {
return m_value;
@@ -167,7 +165,6 @@ public class BERUTCTime extends BERElement {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.UTCTIME;

View File

@@ -98,7 +98,6 @@ public class BERVisibleString extends BERCharacterString {
/**
* Gets the element type.
* @param element type
*/
public int getType() {
return BERElement.VISIBLESTRING;

View File

@@ -48,7 +48,8 @@ import java.io.*;
public class JDAPBERTagDecoder extends BERTagDecoder {
/**
* Gets an application specific ber element from the stream.
* @param buffer ber encoding buffer
* @param decoder ber decoder to use
* @param tag ber tag to get
* @param stream input stream
* @param bytes_read number of bytes read
* @param implicit to indicate a tag implicit or not

View File

@@ -89,8 +89,7 @@ public abstract class JDAPFilter {
* <starval> ::= NULL | <value> '*' <starval>
* <final> ::= NULL | <value>
* </pre>
* @param dn distinguished name of adding entry
* @param attrs list of attribute associated with entry
* @param filter filter string as specified in RFC1558
* @return filter
*/
public static JDAPFilter getFilter(String filter) {

View File

@@ -43,12 +43,12 @@ import java.io.*;
/**
* This class implements the equality match filter.
* See RFC 1777.
* <pre>
* equalityMatch [3] AttributeValueAssertion
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterEqualityMatch extends JDAPFilterAVA {
/**

View File

@@ -43,12 +43,12 @@ import java.io.*;
/**
* This class implements the greater or equal filter.
* See RFC 1777.
* <pre>
* greaterOrEqual [5] AttributeValueAssertion
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterGreaterOrEqual extends JDAPFilterAVA {
/**

View File

@@ -43,12 +43,12 @@ import java.io.*;
/**
* This class implements the filter not.
* See RFC 1777.
* <pre>
* not [2] Filter
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterNot extends JDAPFilter {

View File

@@ -43,12 +43,12 @@ import java.io.*;
/**
* This class implements the filter And.
* See RFC 1777.
* <pre>
* or [1] SET OF Filter
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterOr extends JDAPFilterSet {
/**

View File

@@ -43,12 +43,12 @@ import java.io.*;
/**
* This class implements the filter present.
* See RFC 1777.
* <pre>
* present [7] AttributeType
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterPresent extends JDAPFilter {
/**

View File

@@ -43,6 +43,7 @@ import java.io.*;
/**
* This class implements the filter substring.
* See RFC 1777.
* <pre>
* [4] SEQUENCE {
* type AttributeType,
@@ -55,7 +56,6 @@ import java.io.*;
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPFilterSubString extends JDAPFilter {
/**

View File

@@ -45,13 +45,12 @@ import java.net.*;
/**
* This class implements the abandon request. This object
* is sent to the ldap server.
* is sent to the ldap server. See RFC 1777.
* <pre>
* AbandonRequest ::= [APPLICATION 16] MessageID
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPAbandonRequest implements JDAPProtocolOp {
/**

View File

@@ -45,7 +45,7 @@ import java.io.*;
/**
* This class implements the add request. This object
* is sent to the ldap server.
* is sent to the ldap server. See RFC 1777.
* <pre>
* AddRequest ::= [APPLICATION 8] SEQUENCE {
* entry LDAPDN,
@@ -57,7 +57,6 @@ import java.io.*;
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPAddRequest extends JDAPBaseDNRequest
implements JDAPProtocolOp {

View File

@@ -45,13 +45,13 @@ import java.net.*;
/**
* This class implements the add response. This object
* is sent from the ldap server to the interface.
* is sent from the ldap server to the interface. See
* RFC 1777.
* <pre>
* AddResponse ::= [APPLICATION 9] LDAPResult
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPAddResponse extends JDAPResult implements JDAPProtocolOp {
/**

View File

@@ -44,7 +44,7 @@ import java.io.*;
/**
* This class implements the ExtendedRequest request. This object
* is sent to the ldap server and is a v3 request.
* is sent to the ldap server and is a v3 request. See RFC 1777.
* <pre>
* ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
* requestName [0] LDAPOID,
@@ -53,7 +53,6 @@ import java.io.*;
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPExtendedRequest implements JDAPProtocolOp {
/**

View File

@@ -46,7 +46,7 @@ import java.net.*;
/**
* This class implements the extended response. This object
* is sent from the ldap server to the interface and is
* a v3 response.
* a v3 response. See RFC 1777.
* <pre>
* ExtendedResponse :: [APPLICATION 23] SEQUENCE {
* COMPONENTS OF LDAPResult,
@@ -56,7 +56,6 @@ import java.net.*;
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPExtendedResponse extends JDAPResult
implements JDAPProtocolOp {

View File

@@ -80,7 +80,7 @@ public class JDAPModifyRDNRequest extends JDAPBaseDNRequest
/**
* Constructs modify RDN request.
* @param old_dn old distinguished name
* @param new_dn new distinguished name
* @param new_rdn new distinguished name
* @param delete_old_dn delete the old distinguished name
*/
public JDAPModifyRDNRequest(String old_dn, String new_rdn,
@@ -94,7 +94,7 @@ public class JDAPModifyRDNRequest extends JDAPBaseDNRequest
/**
* Constructs modify DN request.
* @param old_dn old distinguished name
* @param new_dn new distinguished name
* @param new_rdn new distinguished name
* @param delete_old_dn delete the old distinguished name
* @param new_superior parent dn
*/

View File

@@ -45,13 +45,13 @@ import java.net.*;
/**
* This class implements the modify response. This object
* is sent from the ldap server to the interface.
* is sent from the ldap server to the interface. See RFC
* 1777.
* <pre>
* ModifyResponse ::= [APPLICATION 7] LDAPResult
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPModifyResponse extends JDAPResult implements JDAPProtocolOp {
/**

View File

@@ -48,7 +48,6 @@ import java.net.*;
* Each protocol operation must implement this interface.
*
* @version 1.0
* @see RFC1777
*/
public interface JDAPProtocolOp {
/**

View File

@@ -44,13 +44,12 @@ import java.io.*;
import java.net.*;
/**
* This class implements the search result reference.
* This class implements the search result reference. See RFC 1777.
* <pre>
* SearchResultReference :: [APPLICATION 19] SEQUENCE OF LDAPURL
* </pre>
*
* @version 1.0
* @see RFC1777
*/
public class JDAPSearchResultReference implements JDAPProtocolOp {

View File

@@ -84,7 +84,7 @@ public class JSSESocketFactory implements LDAPTLSSocketFactory,
/**
* Factory constructor
* @param sf the SSL socketfactory to use
* @param factory the SSL socketfactory to use
*/
public JSSESocketFactory( SSLSocketFactory factory) {
this.factory = factory;
@@ -95,7 +95,7 @@ public class JSSESocketFactory implements LDAPTLSSocketFactory,
* @param suites Cipher suites to attempt to use with the server;
* if <code>null</code>, use any cipher suites available in the
* JSSE package
* @param sf the SSL socketfactory to use
* @param factory the SSL socketfactory to use
*/
public JSSESocketFactory( String[] suites, SSLSocketFactory factory) {
this.suites = suites;

View File

@@ -320,7 +320,7 @@ public final class ByteBuf implements Serializable {
/**
* Appends a byte to the end of this byte buffer.
* @param ch the byte to append to this buffer
* @param b the byte to append to this buffer
* @return the original <CODE>ByteBuf</CODE> object (not a new object)
* with the specified byte appended.
*/

View File

@@ -100,7 +100,7 @@ public class LDIF implements Serializable {
/**
* Constructs an <CODE>LDIF</CODE> object to parse the
* LDIF data read from an input stream.
* @param dstThe input stream providing the LDIF data
* @param ds The input stream providing the LDIF data
* @exception IOException An I/O error has occurred.
*/
public LDIF(DataInputStream ds) throws IOException {

View File

@@ -298,7 +298,7 @@ public final class RDN implements java.io.Serializable {
/**
* Determines if the specified string is a distinguished name component.
* @param dn the string to check
* @param rdn the string to check
* @return <code>true</code> if the string is a distinguished name component.
*/
public static boolean isRDN(String rdn) {

View File

@@ -93,7 +93,7 @@ public class LdapEntryChangeControl extends LDAPEntryChangeControl implements Co
/**
* Gets the change type, which identifies the type of change
* that occurred.
* @returns Change type identifying the type of change that
* @return Change type identifying the type of change that
* occurred. This can be one of the following values:
* <P>
*
@@ -115,7 +115,7 @@ public class LdapEntryChangeControl extends LDAPEntryChangeControl implements Co
/**
* Gets the previous DN of the entry (if the entry was renamed).
* @returns The previous distinguished name of the entry.
* @return The previous distinguished name of the entry.
*/
public String getPreviousDN() {
return super.getPreviousDN();

View File

@@ -100,7 +100,7 @@ public class NetscapeControlFactory extends ControlFactory {
/**
* Create a JNDI control from a raw ldapjdk control
* @param ctrl A non-null control.
* @param rawCtrl A non-null control.
* @return A possibly null Control.
* @exception NamingException If ctrl contains invalid data that prevents it from
* being used to create a control.