org.gudy.bouncycastle.asn1
Class ASN1TaggedObject

java.lang.Object
  extended by org.gudy.bouncycastle.asn1.ASN1Encodable
      extended by org.gudy.bouncycastle.asn1.DERObject
          extended by org.gudy.bouncycastle.asn1.ASN1Object
              extended by org.gudy.bouncycastle.asn1.ASN1TaggedObject
All Implemented Interfaces:
ASN1TaggedObjectParser, DEREncodable, DERTags
Direct Known Subclasses:
DERTaggedObject

public abstract class ASN1TaggedObject
extends ASN1Object
implements ASN1TaggedObjectParser

ASN.1 TaggedObject - in ASN.1 nottation this is any object proceeded by a [n] where n is some number - these are assume to follow the construction rules (as with sequences).


Field Summary
 
Fields inherited from class org.gudy.bouncycastle.asn1.ASN1Encodable
BER, DER
 
Fields inherited from interface org.gudy.bouncycastle.asn1.DERTags
APPLICATION, BIT_STRING, BMP_STRING, BOOLEAN, CONSTRUCTED, ENUMERATED, EXTERNAL, GENERAL_STRING, GENERALIZED_TIME, GRAPHIC_STRING, IA5_STRING, INTEGER, NULL, NUMERIC_STRING, OBJECT_IDENTIFIER, OCTET_STRING, PRINTABLE_STRING, SEQUENCE, SEQUENCE_OF, SET, SET_OF, T61_STRING, TAGGED, UNIVERSAL_STRING, UTC_TIME, UTF8_STRING, VIDEOTEX_STRING, VISIBLE_STRING
 
Constructor Summary
ASN1TaggedObject(boolean explicit, int tagNo, DEREncodable obj)
          Create a tagged object with the style given by the value of explicit.
ASN1TaggedObject(int tagNo, DEREncodable obj)
          Create a tagged object in the explicit style.
 
Method Summary
static ASN1TaggedObject getInstance(ASN1TaggedObject obj, boolean explicit)
           
static ASN1TaggedObject getInstance(Object obj)
           
 DERObject getObject()
          return whatever was following the tag.
 DEREncodable getObjectParser(int tag, boolean isExplicit)
          Return the object held in this tagged object as a parser assuming it has the type of the passed in tag.
 int getTagNo()
           
 int hashCode()
           
 boolean isEmpty()
           
 boolean isExplicit()
          return whether or not the object may be explicitly tagged.
 String toString()
           
 
Methods inherited from class org.gudy.bouncycastle.asn1.ASN1Object
equals, fromByteArray
 
Methods inherited from class org.gudy.bouncycastle.asn1.DERObject
toASN1Object
 
Methods inherited from class org.gudy.bouncycastle.asn1.ASN1Encodable
getDEREncoded, getDERObject, getEncoded, getEncoded
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.gudy.bouncycastle.asn1.DEREncodable
getDERObject
 

Constructor Detail

ASN1TaggedObject

public ASN1TaggedObject(int tagNo,
                        DEREncodable obj)
Create a tagged object in the explicit style.

Parameters:
tagNo - the tag number for this object.
obj - the tagged object.

ASN1TaggedObject

public ASN1TaggedObject(boolean explicit,
                        int tagNo,
                        DEREncodable obj)
Create a tagged object with the style given by the value of explicit.

If the object implements ASN1Choice the tag style will always be changed to explicit in accordance with the ASN.1 encoding rules.

Parameters:
explicit - true if the object is explicitly tagged.
tagNo - the tag number for this object.
obj - the tagged object.
Method Detail

getInstance

public static ASN1TaggedObject getInstance(ASN1TaggedObject obj,
                                           boolean explicit)

getInstance

public static ASN1TaggedObject getInstance(Object obj)

hashCode

public int hashCode()
Specified by:
hashCode in class ASN1Object

getTagNo

public int getTagNo()
Specified by:
getTagNo in interface ASN1TaggedObjectParser

isExplicit

public boolean isExplicit()
return whether or not the object may be explicitly tagged.

Note: if the object has been read from an input stream, the only time you can be sure if isExplicit is returning the true state of affairs is if it returns false. An implicitly tagged object may appear to be explicitly tagged, so you need to understand the context under which the reading was done as well, see getObject below.


isEmpty

public boolean isEmpty()

getObject

public DERObject getObject()
return whatever was following the tag.

Note: tagged objects are generally context dependent if you're trying to extract a tagged object you should be going via the appropriate getInstance method.


getObjectParser

public DEREncodable getObjectParser(int tag,
                                    boolean isExplicit)
Return the object held in this tagged object as a parser assuming it has the type of the passed in tag. If the object doesn't have a parser associated with it, the base object is returned.

Specified by:
getObjectParser in interface ASN1TaggedObjectParser

toString

public String toString()
Overrides:
toString in class Object