Top Description Fields Constructors Methods
org.bouncycastle.asn1

public Class DERBMPString

extends ASN1Primitive
implements ASN1String
Class Inheritance
All Implemented Interfaces
org.bouncycastle.asn1.ASN1String
Imports
java.io.IOException, org.bouncycastle.util.Arrays
DER BMPString object encodes BMP (Basic Multilingual Plane) subset (aka UCS-2) of UNICODE (ISO 10646) characters in codepoints 0 to 65535.

At ISO-10646:2011 the term "BMP" has been withdrawn, and replaced by term "UCS-2".

Field Summary

Modifier and TypeField and Description
private final char[]
string

Constructor Summary

AccessConstructor and Description
pack-priv
DERBMPString(byte[]
the encoded BMP STRING to wrap.
string)

Basic constructor - byte encoded string.

pack-priv
DERBMPString(char[] string)

public
DERBMPString(String
a String to wrap as a BMP STRING.
string)

Basic constructor

Method Summary

Modifier and TypeMethod and Description
protected boolean
asn1Equals(ASN1Primitive o)

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

Equality (similarity) comparison for two ASN1Primitive objects.
pack-priv void
encode(ASN1OutputStream out)

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encode.

pack-priv int
encodedLength()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodedLength.

Return the length of the encoding this object will produce.
public static DERBMPString

Returns:

a DERBMPString instance, or null.
getInstance(Object
the object we want converted.
obj)

Return a BMP String from the given object.

public static DERBMPString

Returns:

a DERBMPString instance.
getInstance(ASN1TaggedObject
the tagged object holding the object we want
obj, boolean
true if the object is meant to be explicitly tagged false otherwise.
explicit)

Return a BMP String from a tagged object.

public String
getString()

Implements org.bouncycastle.asn1.ASN1String.getString.

Return a Java String representation of this STRING type's content.
public int
hashCode()

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

Returns a hash code value for this object.
pack-priv boolean
isConstructed()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed.

Return true if this objected is a CONSTRUCTED one, false otherwise.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.bouncycastle.asn1.ASN1Primitive:
equalsfromByteArraytoASN1PrimitivetoDERObjecttoDLObject

Field Detail

stringback to summary
private final char[] string

Constructor Detail

DERBMPStringback to summary
pack-priv DERBMPString(byte[] string)

Basic constructor - byte encoded string.

Parameters
string:byte[]

the encoded BMP STRING to wrap.

DERBMPStringback to summary
pack-priv DERBMPString(char[] string)
DERBMPStringback to summary
public DERBMPString(String string)

Basic constructor

Parameters
string:String

a String to wrap as a BMP STRING.

Method Detail

asn1Equalsback to summary
protected boolean asn1Equals(ASN1Primitive o)

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

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

Equality (similarity) comparison for two ASN1Primitive objects.

encodeback to summary
pack-priv void encode(ASN1OutputStream out) throws IOException

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encode.

encodedLengthback to summary
pack-priv int encodedLength()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.encodedLength.

Doc from org.bouncycastle.asn1.ASN1Primitive.encodedLength.

Return the length of the encoding this object will produce.

Returns:int

the length of the object's encoding.

getInstanceback to summary
public static DERBMPString getInstance(Object obj)

Return a BMP String from the given object.

Parameters
obj:Object

the object we want converted.

Returns:DERBMPString

a DERBMPString instance, or null.

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

Return a BMP String from a tagged object.

Parameters
obj:ASN1TaggedObject

the tagged object holding the object we want

explicit:boolean

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

Returns:DERBMPString

a DERBMPString instance.

Exceptions
IllegalArgumentException:
if the tagged object cannot be converted.
getStringback to summary
public String getString()

Implements org.bouncycastle.asn1.ASN1String.getString.

Doc from org.bouncycastle.asn1.ASN1String.getString.

Return a Java String representation of this STRING type's content.

Returns:String

a Java String representation of this STRING.

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

isConstructedback to summary
pack-priv boolean isConstructed()

Implements abstract org.bouncycastle.asn1.ASN1Primitive.isConstructed.

Doc from org.bouncycastle.asn1.ASN1Primitive.isConstructed.

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

Returns:boolean

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

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object