You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by dr...@apache.org on 2015/02/09 07:27:55 UTC
[14/30] directory-kerberos git commit: Added some javadocs
Added some javadocs
Project: http://git-wip-us.apache.org/repos/asf/directory-kerberos/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerberos/commit/64404d7a
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerberos/tree/64404d7a
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerberos/diff/64404d7a
Branch: refs/heads/installation
Commit: 64404d7acb0aa9f9d45fea5d97212ba0679d12ba
Parents: f504a17
Author: Drankye <dr...@gmail.com>
Authored: Mon Feb 2 05:47:04 2015 +0800
Committer: Drankye <dr...@gmail.com>
Committed: Mon Feb 2 05:47:04 2015 +0800
----------------------------------------------------------------------
.../org/apache/kerby/asn1/EncodingOption.java | 7 +++----
.../apache/kerby/asn1/type/AbstractAsn1Type.java | 18 +++++++++++++++++-
.../org/apache/kerby/asn1/type/Asn1Boolean.java | 13 +++++++++++--
.../apache/kerby/asn1/type/Asn1Collection.java | 6 ++++--
.../kerby/asn1/type/Asn1GeneralizedTime.java | 3 +--
.../kerby/asn1/type/Asn1ObjectIdentifier.java | 6 ++++--
.../org/apache/kerby/asn1/type/Asn1Simple.java | 13 +++++++++++++
7 files changed, 53 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
index 87a6f27..bac3d19 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
@@ -24,8 +24,7 @@ package org.apache.kerby.asn1;
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public enum EncodingOption
-{
+public enum EncodingOption {
UNKNOWN(-1),
PRIMITIVE(1),
CONSTRUCTED(2),
@@ -53,7 +52,7 @@ public enum EncodingOption
/**
- * @return The integer value associated with the ENcodingOption instance
+ * @return The integer value associated with the EncodingOption instance
*/
public int getValue() {
return value;
@@ -129,7 +128,7 @@ public enum EncodingOption
/**
- * Get the EncodingOption given an interger value
+ * Get the EncodingOption given an integer value
* @param value The value to translate
* @return The associated EncodingOption
*/
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
index f7df523..9605646 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
@@ -44,7 +44,7 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
private T value;
/**
- *
+ * Default constructor, generally for decoding as a value container
* @param tagClass
* @param tagNo
*/
@@ -52,15 +52,31 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
this(tagClass, tagNo, null);
}
+ /**
+ * Default constructor, generally for decoding as a value container
+ * @param tagFlags
+ * @param tagNo
+ */
public AbstractAsn1Type(int tagFlags, int tagNo) {
this(tagFlags, tagNo, null);
}
+ /**
+ * Constructor with a value, generally for encoding of the value
+ * @param tagFlags
+ * @param tagNo
+ * @param value
+ */
public AbstractAsn1Type(int tagFlags, int tagNo, T value) {
this(TagClass.fromTagFlags(tagFlags), tagNo, value);
setTagFlags(tagFlags);
}
+ /**
+ * Constructor with a value, generally for encoding of the value
+ * @param tagNo
+ * @param value
+ */
public AbstractAsn1Type(TagClass tagClass, int tagNo, T value) {
this.tagClass = tagClass;
this.tagNo = tagNo;
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
index e5a6188..33ab327 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
@@ -24,18 +24,27 @@ import org.apache.kerby.asn1.UniversalTag;
import java.io.IOException;
-public class Asn1Boolean extends Asn1Simple<Boolean>
-{
+/**
+ * ASN1 Boolean type
+ */
+public class Asn1Boolean extends Asn1Simple<Boolean> {
private static final byte[] TRUE_BYTE = new byte[] { (byte)0xff };
private static final byte[] FALSE_BYTE = new byte[] { (byte)0x00 };
public static final Asn1Boolean TRUE = new Asn1Boolean(true);
public static final Asn1Boolean FALSE = new Asn1Boolean(false);
+ /**
+ * Default constructor, generally for decoding as a container
+ */
public Asn1Boolean() {
this(null);
}
+ /**
+ * Constructor with a value, generally for encoding of the value
+ * @param value
+ */
public Asn1Boolean(Boolean value) {
super(UniversalTag.BOOLEAN, value);
}
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Collection.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Collection.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Collection.java
index 58dc6a3..5ea02f1 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Collection.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Collection.java
@@ -29,8 +29,10 @@ import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.List;
-public class Asn1Collection extends AbstractAsn1Type<List<Asn1Item>>
-{
+/**
+ * ASN1 complex type, may be better named.
+ */
+public class Asn1Collection extends AbstractAsn1Type<List<Asn1Item>> {
public Asn1Collection(TagClass tagClass, int tagNo) {
super(tagClass, tagNo);
setValue(new ArrayList<Asn1Item>());
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
index 9341f1a..4346f65 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
@@ -29,8 +29,7 @@ import java.util.Date;
import java.util.SimpleTimeZone;
import java.util.TimeZone;
-public class Asn1GeneralizedTime extends Asn1Simple<Date>
-{
+public class Asn1GeneralizedTime extends Asn1Simple<Date> {
public Asn1GeneralizedTime() {
this(null);
}
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1ObjectIdentifier.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1ObjectIdentifier.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1ObjectIdentifier.java
index e6a49ec..d12f6ca 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1ObjectIdentifier.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1ObjectIdentifier.java
@@ -24,8 +24,10 @@ import org.apache.kerby.asn1.UniversalTag;
import java.math.BigInteger;
import java.nio.ByteBuffer;
-public class Asn1ObjectIdentifier extends Asn1Simple<String>
-{
+/**
+ * ASN1 object identifier.
+ */
+public class Asn1ObjectIdentifier extends Asn1Simple<String> {
public Asn1ObjectIdentifier() {
this(null);
}
http://git-wip-us.apache.org/repos/asf/directory-kerberos/blob/64404d7a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
index 11296be..6c4352c 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
@@ -27,13 +27,26 @@ import org.apache.kerby.asn1.UniversalTag;
import java.io.IOException;
import java.nio.ByteBuffer;
+/**
+ * ASN1 simple type, of single value other than complex type of multiple values.
+ * @param <T>
+ */
public abstract class Asn1Simple<T> extends AbstractAsn1Type<T> {
private byte[] bytes;
+ /**
+ * Default constructor, generally for decoding as a value container
+ * @param tagNo
+ */
public Asn1Simple(UniversalTag tagNo) {
this(tagNo, null);
}
+ /**
+ * Constructor with a value, generally for encoding of the value
+ * @param tagNo
+ * @param value
+ */
public Asn1Simple(UniversalTag tagNo, T value) {
super(TagClass.UNIVERSAL, tagNo.getValue(), value);
setEncodingOption(EncodingOption.PRIMITIVE);