directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From erodrig...@apache.org
Subject svn commit: r537093 - in /directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared: io/decoder/ messages/value/
Date Fri, 11 May 2007 05:01:46 GMT
Author: erodriguez
Date: Thu May 10 22:01:45 2007
New Revision: 537093

URL: http://svn.apache.org/viewvc?view=rev&rev=537093
Log:
Javadocs and minor warning clean-up.

Modified:
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/ChecksumDecoder.java
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/Decoder.java
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/DecoderFactory.java
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/KerberosTime.java
    directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/TicketFlags.java

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/ChecksumDecoder.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/ChecksumDecoder.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/ChecksumDecoder.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/ChecksumDecoder.java
Thu May 10 22:01:45 2007
@@ -42,6 +42,8 @@
      *          cksumtype[0]   INTEGER,
      *          checksum[1]    OCTET STRING
      * }
+     * @param sequence 
+     * @return The {@link Checksum}.
      */
     public static Checksum decode( DERSequence sequence )
     {

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/Decoder.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/Decoder.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/Decoder.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/Decoder.java
Thu May 10 22:01:45 2007
@@ -32,5 +32,12 @@
  */
 public interface Decoder
 {
+    /**
+     * Decodes the byte array into an {@link Encodable} object.
+     *
+     * @param object
+     * @return The {@link Encodable} object.
+     * @throws IOException
+     */
     public Encodable decode( byte[] object ) throws IOException;
 }

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/DecoderFactory.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/DecoderFactory.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/DecoderFactory.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/io/decoder/DecoderFactory.java
Thu May 10 22:01:45 2007
@@ -27,5 +27,10 @@
  */
 public interface DecoderFactory
 {
+    /**
+     * Returns the {@link Decoder}.
+     *
+     * @return The {@link Decoder}.
+     */
     public Decoder getDecoder();
 }

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java
Thu May 10 22:01:45 2007
@@ -37,16 +37,24 @@
 
 
     /**
-     * Class constructors
+     * Creates a new instance of HostAddress.
+     *
+     * @param addressType
+     * @param address
      */
-    public HostAddress(HostAddressType addressType, byte[] address)
+    public HostAddress( HostAddressType addressType, byte[] address )
     {
         this.addressType = addressType;
         this.address = address;
     }
 
 
-    public HostAddress(InetAddress internetAddress)
+    /**
+     * Creates a new instance of HostAddress.
+     *
+     * @param internetAddress
+     */
+    public HostAddress( InetAddress internetAddress )
     {
         addressType = HostAddressType.ADDRTYPE_INET;
         byte[] newAddress = internetAddress.getAddress();
@@ -55,6 +63,12 @@
     }
 
 
+    /**
+     * Returns whether one {@link HostAddress} is equal to another.
+     *
+     * @param that
+     * @return true if the {@link HostAddress}'s are equal.
+     */
     public boolean equals( HostAddress that )
     {
         if ( this.addressType != that.addressType || ( this.address != null && that.address
== null )
@@ -83,12 +97,22 @@
     }
 
 
+    /**
+     * Get the bytes for this address.
+     *
+     * @return The bytes of this address.
+     */
     public byte[] getAddress()
     {
         return address;
     }
 
 
+    /**
+     * Returns the {@link HostAddressType} of this {@link HostAddress}.
+     *
+     * @return The {@link HostAddressType}.
+     */
     public HostAddressType getAddressType()
     {
         return addressType;

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/KerberosTime.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/KerberosTime.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/KerberosTime.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/KerberosTime.java
Thu May 10 22:01:45 2007
@@ -23,6 +23,7 @@
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+import java.util.List;
 import java.util.TimeZone;
 
 
@@ -32,7 +33,7 @@
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
  */
-public class KerberosTime implements Comparable
+public class KerberosTime implements Comparable<KerberosTime>
 {
     public static final KerberosTime INFINITY = new KerberosTime( Long.MAX_VALUE );
 
@@ -76,7 +77,7 @@
     }
 
     
-    public int compareTo( Object o )
+    public int compareTo( KerberosTime o )
     {
         final int BEFORE = -1;
         final int EQUAL = 0;

Modified: directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/TicketFlags.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/TicketFlags.java?view=diff&rev=537093&r1=537092&r2=537093
==============================================================================
--- directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/TicketFlags.java
(original)
+++ directory/apacheds/branches/kerberos-encryption-types/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/TicketFlags.java
Thu May 10 22:01:45 2007
@@ -26,36 +26,78 @@
  */
 public class TicketFlags extends Options
 {
-    // Ticket flag - reserved
+    /**
+     * Ticket flag - reserved
+     */
     public static final int RESERVED = 0;
-    // Ticket flag - forwardable
+
+    /**
+     * Ticket flag - forwardable
+     */
     public static final int FORWARDABLE = 1;
-    // Ticket flag - forwarded
+
+    /**
+     * Ticket flag - forwarded
+     */
     public static final int FORWARDED = 2;
-    // Ticket flag - proxiable
+
+    /**
+     * Ticket flag - proxiable
+     */
     public static final int PROXIABLE = 3;
-    // Ticket flag - proxy
+
+    /**
+     * Ticket flag - proxy
+     */
     public static final int PROXY = 4;
-    // Ticket flag - may be postdated
+
+    /**
+     * Ticket flag - may be postdated
+     */
     public static final int MAY_POSTDATE = 5;
-    // Ticket flag - postdated
+
+    /**
+     * Ticket flag - postdated
+     */
     public static final int POSTDATED = 6;
-    // Ticket flag - invalid
+    /**
+     * Ticket flag - invalid
+     */
     public static final int INVALID = 7;
-    // Ticket flag - renewable
+
+    /**
+     * Ticket flag - renewable
+     */
     public static final int RENEWABLE = 8;
-    // Ticket flag - initial
+
+    /**
+     * Ticket flag - initial
+     */
     public static final int INITIAL = 9;
-    // Ticket flag - pre-authentication
+
+    /**
+     * Ticket flag - pre-authentication
+     */
     public static final int PRE_AUTHENT = 10;
-    // Ticket flag - hardware authentication
+
+    /**
+     * Ticket flag - hardware authentication
+     */
     public static final int HW_AUTHENT = 11;
-    // Ticket flag - transitedEncoding policy checked
+
+    /**
+     * Ticket flag - transitedEncoding policy checked
+     */
     public static final int TRANSITED_POLICY_CHECKED = 12;
-    // Ticket flag - OK as delegate
+
+    /**
+     * Ticket flag - OK as delegate
+     */
     public static final int OK_AS_DELEGATE = 13;
 
-    // Ticket flag - maximum value
+    /**
+     * Ticket flag - maximum value
+     */
     public static final int MAX_VALUE = 32;
 
 
@@ -68,7 +110,12 @@
     }
 
 
-    public TicketFlags(byte[] options)
+    /**
+     * Creates a new instance of TicketFlags.
+     *
+     * @param options
+     */
+    public TicketFlags( byte[] options )
     {
         super( MAX_VALUE );
         setBytes( options );
@@ -76,7 +123,7 @@
 
 
     /**
-     * Converts the object to a printable string
+     * Converts the object to a printable string.
      */
     public String toString()
     {



Mime
View raw message