Top Description Fields Constructors Methods
org.bouncycastle.asn1

public Class DERPrintableString

extends ASN1Primitive
implements ASN1String
Class Inheritance
All Implemented Interfaces
org.bouncycastle.asn1.ASN1String
Imports
java.io.IOException, org.bouncycastle.util.Arrays, .Strings
DER PrintableString object.

X.680 section 37.4 defines PrintableString character codes as ASCII subset of following characters:

Explicit character set escape sequences are not allowed.

Field Summary

Modifier and TypeField and Description
private final byte[]
string

Constructor Summary

AccessConstructor and Description
pack-priv
DERPrintableString(byte[] string)

Basic constructor - byte encoded string.

public
DERPrintableString(String string)

Basic constructor - this does not validate the string

public
DERPrintableString(String
the base string to wrap.
string, boolean
whether or not to check the string.
validate)

Constructor with optional validation.

Method Summary

Modifier and TypeMethod and Description
pack-priv 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 DERPrintableString

Returns:

a DERPrintableString instance, or null.
getInstance(Object
a DERPrintableString or an object that can be converted into one.
obj)

Return a printable string from the passed in object.

public static DERPrintableString

Returns:

a DERPrintableString instance, or null.
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 Printable String from a tagged object.

public byte[]
getOctets()

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 static boolean

Returns:

true if in printable set, false otherwise.
isPrintableString(String str)

return true if the passed in String can be represented without loss as a PrintableString, 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 byte[] string

Constructor Detail

DERPrintableStringback to summary
pack-priv DERPrintableString(byte[] string)

Basic constructor - byte encoded string.

DERPrintableStringback to summary
public DERPrintableString(String string)

Basic constructor - this does not validate the string

DERPrintableStringback to summary
public DERPrintableString(String string, boolean validate)

Constructor with optional validation.

Parameters
string:String

the base string to wrap.

validate:boolean

whether or not to check the string.

Exceptions
IllegalArgumentException:
if validate is true and the string contains characters that should not be in a PrintableString.

Method Detail

asn1Equalsback to summary
pack-priv 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 DERPrintableString getInstance(Object obj)

Return a printable string from the passed in object.

Parameters
obj:Object

a DERPrintableString or an object that can be converted into one.

Returns:DERPrintableString

a DERPrintableString instance, or null.

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

Return a Printable 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:DERPrintableString

a DERPrintableString instance, or null.

Exceptions
IllegalArgumentException:
if the tagged object cannot be converted.
getOctetsback to summary
public byte[] getOctets()
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.

isPrintableStringback to summary
public static boolean isPrintableString(String str)

return true if the passed in String can be represented without loss as a PrintableString, false otherwise.

Returns:boolean

true if in printable set, 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