Top Description Fields Constructors Methods
org.bouncycastle.asn1

public abstract Class ASN1Sequence

extends ASN1Primitive
implements Iterable<ASN1Encodable>
Class Inheritance
All Implemented Interfaces
org.bouncycastle.util.Iterable, java.lang.Iterable
Known Direct Subclasses
org.bouncycastle.asn1.DERSequence, org.bouncycastle.asn1.LazyEncodedSequence, org.bouncycastle.asn1.BERSequence, org.bouncycastle.asn1.DLSequence
Imports
java.io.IOException, java.util.Enumeration, .Iterator, .NoSuchElementException, org.bouncycastle.util.Arrays
ASN.1 SEQUENCE and SEQUENCE OF constructs.

DER form is always definite form length fields, while BER support uses indefinite form.

X.690

8: Basic encoding rules

8.9 Encoding of a sequence value

8.9.1 The encoding of a sequence value shall be constructed.

8.9.2 The contents octets shall consist of the complete encoding of one data value from each of the types listed in the ASN.1 definition of the sequence type, in the order of their appearance in the definition, unless the type was referenced with the keyword OPTIONAL or the keyword DEFAULT.

8.9.3 The encoding of a data value may, but need not, be present for a type which was referenced with the keyword OPTIONAL or the keyword DEFAULT. If present, it shall appear in the encoding at the point corresponding to the appearance of the type in the ASN.1 definition.

8.10 Encoding of a sequence-of value

8.10.1 The encoding of a sequence-of value shall be constructed.

8.10.2 The contents octets shall consist of zero, one or more complete encodings of data values from the type listed in the ASN.1 definition.

8.10.3 The order of the encodings of the data values shall be the same as the order of the data values in the sequence-of value to be encoded.

9: Canonical encoding rules

9.1 Length forms

If the encoding is constructed, it shall employ the indefinite-length form. If the encoding is primitive, it shall include the fewest length octets necessary. [Contrast with 8.1.3.2 b).]

11: Restrictions on BER employed by both CER and DER

11.5 Set and sequence components with default value

The encoding of a set value or sequence value shall not include an encoding for any component value which is equal to its default value.

Field Summary

Modifier and TypeField and Description
pack-priv ASN1Encodable[]
elements

pack-priv static final ASN1UniversalType
TYPE

Constructor Summary

AccessConstructor and Description
protected
ASN1Sequence()

Create an empty SEQUENCE

protected
ASN1Sequence(ASN1Encodable
the object to be put in the SEQUENCE.
element)

Create a SEQUENCE containing one object.

protected
ASN1Sequence(ASN1Encodable
the first object to be put in the SEQUENCE.
element1, ASN1Encodable
the second object to be put in the SEQUENCE.
element2)

Create a SEQUENCE containing two objects.

protected
ASN1Sequence(ASN1EncodableVector
the vector of objects to be put in the SEQUENCE.
elementVector)

Create a SEQUENCE containing a vector of objects.

protected
ASN1Sequence(ASN1Encodable[]
the array of objects to be put in the SEQUENCE.
elements)

Create a SEQUENCE containing an array of objects.

pack-priv
ASN1Sequence(ASN1Encodable[] elements, boolean clone)

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
asn1Equals(ASN1Primitive other)

Implements abstract org.bouncycastle.asn1.ASN1Primitive.asn1Equals.

Equality (similarity) comparison for two ASN1Primitive objects.

pack-priv boolean
encodeConstructed()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodeConstructed.

Return true if this objected is a CONSTRUCTED one, false otherwise.

pack-priv ASN1BitString[]
getConstructedBitStrings()

pack-priv ASN1OctetString[]
getConstructedOctetStrings()

public static ASN1Sequence

Returns:

an ASN1Sequence instance, or null.
getInstance(Object
the object we want converted.
obj)

Return an ASN1Sequence from the given object.

public static ASN1Sequence

Returns:

an ASN1Sequence instance.
getInstance(ASN1TaggedObject
the tagged object.
taggedObject, boolean
true if the object is meant to be explicitly tagged, false otherwise.
explicit)

Return an ASN1 SEQUENCE from a tagged object.

public ASN1Encodable

Returns:

the object at the sequence position indicated by index.
getObjectAt(int
the sequence number (starting at zero) of the object
index)

Return the object at the sequence position indicated by index.

public Enumeration<E>
getObjects()

public int
hashCode()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.hashCode.

Returns a hash code value for this object.

public Iterator<ASN1Encodable>
iterator()

Implements org.bouncycastle.util.Iterable.iterator.

Returns an iterator over a set of elements of type T.

public ASN1SequenceParser
parser()

public int

Returns:

the number of objects in this sequence.
size()

Return the number of objects in this sequence.

public ASN1Encodable[]
toArray()

pack-priv ASN1Encodable[]
toArrayInternal()

pack-priv abstract ASN1BitString
toASN1BitString()

pack-priv abstract ASN1External
toASN1External()

pack-priv abstract ASN1OctetString
toASN1OctetString()

pack-priv abstract ASN1Set
toASN1Set()

pack-priv ASN1Primitive
toDERObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDERObject.

Change current SEQUENCE object to be encoded as DERSequence.

pack-priv ASN1Primitive
toDLObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDLObject.

Change current SEQUENCE object to be encoded as DLSequence.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.bouncycastle.asn1.ASN1Primitive:
encodeencodedLengthencodeToencodeToequalsequalsequalsfromByteArraytoASN1Primitive

Field Detail

elementsback to summary
pack-priv ASN1Encodable[] elements
TYPEback to summary
pack-priv static final ASN1UniversalType TYPE

Constructor Detail

ASN1Sequenceback to summary
protected ASN1Sequence()

Create an empty SEQUENCE

ASN1Sequenceback to summary
protected ASN1Sequence(ASN1Encodable element)

Create a SEQUENCE containing one object.

Parameters
element:ASN1Encodable

the object to be put in the SEQUENCE.

ASN1Sequenceback to summary
protected ASN1Sequence(ASN1Encodable element1, ASN1Encodable element2)

Create a SEQUENCE containing two objects.

Parameters
element1:ASN1Encodable

the first object to be put in the SEQUENCE.

element2:ASN1Encodable

the second object to be put in the SEQUENCE.

ASN1Sequenceback to summary
protected ASN1Sequence(ASN1EncodableVector elementVector)

Create a SEQUENCE containing a vector of objects.

Parameters
elementVector:ASN1EncodableVector

the vector of objects to be put in the SEQUENCE.

ASN1Sequenceback to summary
protected ASN1Sequence(ASN1Encodable[] elements)

Create a SEQUENCE containing an array of objects.

Parameters
elements:ASN1Encodable[]

the array of objects to be put in the SEQUENCE.

ASN1Sequenceback to summary
pack-priv ASN1Sequence(ASN1Encodable[] elements, boolean clone)

Method Detail

asn1Equalsback to summary
pack-priv boolean asn1Equals(ASN1Primitive other)

Implements abstract org.bouncycastle.asn1.ASN1Primitive.asn1Equals.

Doc from org.bouncycastle.asn1.ASN1Primitive.asn1Equals.

Equality (similarity) comparison for two ASN1Primitive objects.

encodeConstructedback to summary
pack-priv boolean encodeConstructed()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodeConstructed.

Doc from org.bouncycastle.asn1.ASN1Primitive.encodeConstructed.

Return true if this objected is a CONSTRUCTED one, false otherwise.

Returns:boolean

true if CONSTRUCTED bit set on object's tag, false otherwise.

getConstructedBitStringsback to summary
pack-priv ASN1BitString[] getConstructedBitStrings()
getConstructedOctetStringsback to summary
pack-priv ASN1OctetString[] getConstructedOctetStrings()
getInstanceback to summary
public static ASN1Sequence getInstance(Object obj)

Return an ASN1Sequence from the given object.

Parameters
obj:Object

the object we want converted.

Returns:ASN1Sequence

an ASN1Sequence instance, or null.

Exceptions
IllegalArgumentException:
if the object cannot be converted.
getInstanceback to summary
public static ASN1Sequence getInstance(ASN1TaggedObject taggedObject, boolean explicit)

Return an ASN1 SEQUENCE from a tagged object. There is a special case here, if an object appears to have been explicitly tagged on reading but we were expecting it to be implicitly tagged in the normal course of events it indicates that we lost the surrounding sequence - so we need to add it back (this will happen if the tagged object is a sequence that contains other sequences). If you are dealing with implicitly tagged sequences you really should be using this method.

Parameters
taggedObject:ASN1TaggedObject

the tagged object.

explicit:boolean

true if the object is meant to be explicitly tagged, false otherwise.

Returns:ASN1Sequence

an ASN1Sequence instance.

Exceptions
IllegalArgumentException:
if the tagged object cannot be converted.
getObjectAtback to summary
public ASN1Encodable getObjectAt(int index)

Return the object at the sequence position indicated by index.

Parameters
index:int

the sequence number (starting at zero) of the object

Returns:ASN1Encodable

the object at the sequence position indicated by index.

getObjectsback to summary
public Enumeration<E> getObjects()
hashCodeback to summary
public int hashCode()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

iteratorback to summary
public Iterator<ASN1Encodable> iterator()

Implements org.bouncycastle.util.Iterable.iterator.

Doc from org.bouncycastle.util.Iterable.iterator.

Returns an iterator over a set of elements of type T.

Returns:Iterator<ASN1Encodable>

an Iterator.

parserback to summary
public ASN1SequenceParser parser()
sizeback to summary
public int size()

Return the number of objects in this sequence.

Returns:int

the number of objects in this sequence.

toArrayback to summary
public ASN1Encodable[] toArray()
toArrayInternalback to summary
pack-priv ASN1Encodable[] toArrayInternal()
toASN1BitStringback to summary
pack-priv abstract ASN1BitString toASN1BitString()
toASN1Externalback to summary
pack-priv abstract ASN1External toASN1External()
toASN1OctetStringback to summary
pack-priv abstract ASN1OctetString toASN1OctetString()
toASN1Setback to summary
pack-priv abstract ASN1Set toASN1Set()
toDERObjectback to summary
pack-priv ASN1Primitive toDERObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDERObject.

Change current SEQUENCE object to be encoded as DERSequence. This is part of Distinguished Encoding Rules form serialization.

Returns:ASN1Primitive

Doc from org.bouncycastle.asn1.ASN1Primitive.toDERObject.

a DER version of this.

toDLObjectback to summary
pack-priv ASN1Primitive toDLObject()

Overrides org.bouncycastle.asn1.ASN1Primitive.toDLObject.

Change current SEQUENCE object to be encoded as DLSequence. This is part of Direct Length form serialization.

Returns:ASN1Primitive

Doc from org.bouncycastle.asn1.ASN1Primitive.toDLObject.

a DL version of this.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object