Asn1PerEncodeBuffer

java.lang.Object
- com.objsys.asn1j.runtime.Asn1MessageBufferBase
- - com.objsys.asn1j.runtime.Asn1MessageBuffer
  - - com.objsys.asn1j.runtime.Asn1EncodeBuffer
    - - com.objsys.asn1j.runtime.Asn1EncodeBitBuffer
      - com.objsys.asn1j.runtime.Asn1PerEncodeBuffer

All Implemented Interfaces:

Asn1BitMessageBuffer, Asn1PerEncoder, Asn1PerMessageBuffer, Asn1Writable
```
public class Asn1PerEncodeBuffer
extends Asn1EncodeBitBuffer
implements Asn1PerMessageBuffer, Asn1PerEncoder
```
This class handles the encoding of ASN.1 messages as specified in the Packed Encoding Rules (PER) as specified in the ITU-T X.691 standard.

Field Summary
- Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer
  mByteIndex, mData, mTraceHandler
- Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer
  INITIAL_SIZE
- Fields inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase
  context, mTypeCode

Constructor Summary

Constructors
Constructor and Description
`Asn1PerEncodeBuffer(boolean aligned)` This constructor creates a PER encode buffer object with the default initial size.
`Asn1PerEncodeBuffer(boolean aligned, int size)` This constructor creates a PER encode buffer object with the given initial size.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`byteAlign()` This method byte-aligns the buffer if the buffer is set to be aligned.
`void`	`encodeBit(boolean value)` This method encodes a single bit value.
`void`	`encodeBit(boolean value, java.lang.String ident)` This method encodes a single bit value.
`void`	`encodeBits(byte[] value, int offset, int nbits)` This method encodes bit values from an array of octets.
`void`	`encodeBits(byte[] value, int offset, int bitOffset, int nbits)` This method encodes bit values from an array of octets.
`void`	`encodeBits(byte[] value, int offset, int bitOffset, int nbits, java.lang.String ident)` This method encodes bit values from an array of octets.
`void`	`encodeBits(byte[] value, int offset, int nbits, java.lang.String ident)` This method encodes bit values from an array of octets.
`void`	`encodeCharString(java.lang.String value, int nchars, int offset, int abpc, int ubpc, Asn1CharSet charSet)` This method encodes the contents of a known-multiplier character string type.
`void`	`encodeConsWholeNumber(long adjustedValue, long rangeValue)` This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard.
`void`	`encodeConsWholeNumber(long adjustedValue, long rangeValue, java.lang.String ident)` This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard.
`void`	`encodeInt(long value, boolean encodeLen, boolean signExtend)` This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard.
`void`	`encodeInt(long value, boolean encodeLen, boolean signExtend, java.lang.String ident)` This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard.
`void`	`encodeInt(long value, int nbits)` This method encodes bit values from an integer value.
`void`	`encodeInt(long value, int nbits, java.lang.String ident)` This method encodes bit values from an integer value.
`long`	`encodeLength(long value)` This method encodes either a constrained or unconstrained length depending on whether a size constraint object is set in this object.
`void`	`encodeLength(long value, long lower, long upper)` This method encodes a constrained length determinant value.
`void`	`encodeLengthEOM(long value)` This method checks to see if a zero byte needs to be added after a fragmented length has been encoded.
`void`	`encodeOctetString(byte[] value, int offset, int nbytes)` This method encodes the given array of bytes as an unconstrained octet string value.
`void`	`encodeOIDLengthAndValue(int[] value)` This method encodes the length and contents of an object identifier value.
`void`	`encodeOpenType(Asn1PerEncodeBuffer buffer, java.lang.String elemName)` This overloaded version of encodeOpenType will encode the componet in the given PER encode buffer into this PER encode buffer.
`void`	`encodeOpenType(byte[] value, int offset, int nbytes)` This method encodes the given array of bytes as an open type.
`void`	`encodeRelOIDLengthAndValue(int[] value)` This method encodes the length and contents of a relative object identifier value.
`void`	`encodeSmallLength(int value)` This method implements the rules to encode a normally small length as specified in section 11.9 of the X.691 standard.
`void`	`encodeSmallNonNegWholeNumber(int value)` This method implements the rules to encode a small non-negative whole number as specified in section 10.6 of the X.691 standard.
`long`	`encodeUnconsLength(long value)` This method encodes a general (unconstrained) length determinant value as described in section 10.9 or the X.691 standard.
`boolean`	`isAligned()` This method is used to test if PER aligned encoding has been specified.
`void`	`setAligned(boolean value)` This method is used to turn PER aligned encoding on or off
`void`	`setSizeConstraint(long lower, long upper)` This method is used to set a size constraint within the buffer object.
`void`	`setSizeConstraintExt(long lower, long upper, long extLower, long extUpper)` This method is used to set an extensible size constraint within the buffer object.

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer
binDump, checkSize, copy, copy, encodeBits, encodeLongBits, encodeLongBits, getBitOffsetInByte, getBuffer, getByteArrayInputStream, getByteIndex, getMsgBitCnt, getMsgByteCnt, getMsgCopy, getMsgLength, getTraceHandler, hexDump, isByteAligned, reset, reverseBytes, setMsgBitCnt, toString, write, write, write, write

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer
binDump, copy, encodeIntSigned, encodeIntUnsigned, getInputStream, getMinimalOctetsSigned, getMinimalOctetsUnsigned, getOutputStream, hexDump

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBuffer
addNamedEventHandler, getEventHandlerListCount, hasEventHandlers, invokeCharacters, invokeEndElement, invokeStartElement, setEventHandlerList

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase
getContext, hexDump, hexDump, setKey, setTypeCode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.objsys.asn1j.runtime.Asn1BitMessageBuffer
getInputStream, getMsgBitCnt, getTraceHandler

Methods inherited from interface com.objsys.asn1j.runtime.Asn1PerEncoder
encodeBits

- Constructor Detail
  - Asn1PerEncodeBuffer
```
public Asn1PerEncodeBuffer(boolean aligned)
```
    This constructor creates a PER encode buffer object with the default initial size. Whenever the buffer becomes full, it will be expanded.
    
    Parameters:
    
    aligned - Indicates whether PER aligned or unaligned encoding should be done.
  - Asn1PerEncodeBuffer
```
public Asn1PerEncodeBuffer(boolean aligned,
                           int size)
```
    This constructor creates a PER encode buffer object with the given initial size. Whenever the buffer becomes full, it will be expanded. For best performance, this size should be large enough to prevent resizing in normal operation.
    
    Parameters:
    
    aligned - Indicates whether PER aligned or unaligned encoding should be done.
    
    size - The initial size in bytes of an encode buffer.
- Method Detail
  - byteAlign
```
public void byteAlign()
```
    This method byte-aligns the buffer if the buffer is set to be aligned.
    
    Specified by:
    
    byteAlign in interface Asn1BitMessageBuffer
    
    Overrides:
    
    byteAlign in class Asn1EncodeBitBuffer
  - encodeBit
```
public void encodeBit(boolean value,
                      java.lang.String ident)
```
    This method encodes a single bit value.
    
    Specified by:
    
    encodeBit in interface Asn1PerEncoder
    
    Parameters:
    
    value - Boolean value of bit to be encoded.
    
    ident - Bit field identifier name for tracing.
  - encodeBit
```
public void encodeBit(boolean value)
```
    This method encodes a single bit value. This overrides the parent class method in order to default the name for tracing to "value". Equivalent to encodeBit(value, "value");
    
    Specified by:
    
    encodeBit in interface Asn1PerEncoder
    
    Overrides:
    
    encodeBit in class Asn1EncodeBitBuffer
    
    Parameters:
    
    value - Boolean value of bit to be encoded.
  - encodeBits
```
public void encodeBits(byte[] value,
                       int offset,
                       int nbits,
                       java.lang.String ident)
                throws Asn1InvalidArgException
```
    This method encodes bit values from an array of octets.
    
    Specified by:
    
    encodeBits in interface Asn1PerEncoder
    
    Parameters:
    
    value - Octet array containing bits to be encoded
    
    offset - Starting byte offset in value
    
    nbits - Number of bits to encode
    
    ident - Bit field identifier name for tracing, or null.
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeBits
```
public void encodeBits(byte[] value,
                       int offset,
                       int bitOffset,
                       int nbits,
                       java.lang.String ident)
                throws Asn1InvalidArgException
```
    This method encodes bit values from an array of octets.
    
    Parameters:
    
    value - Octet array containing bits to be encoded
    
    offset - Starting byte offset in value
    
    bitOffset - Starting bit offset in first byte. Pass 0 to begin encoding with the most significant bit. Pass 7 to begin with the least significant bit.
    
    nbits - Number of bits to encode
    
    ident - Bit field identifier name for tracing, or null.
    
    Throws:
    
    Asn1InvalidArgException
  - encodeBits
```
public void encodeBits(byte[] value,
                       int offset,
                       int bitOffset,
                       int nbits)
```
    This method encodes bit values from an array of octets. This overrides the parent class method in order to default the name for tracing to "value". Equivalent to: encodeBits(value, offset, bitOffset, nbits, "value");
    
    Overrides:
    
    encodeBits in class Asn1EncodeBitBuffer
    
    Parameters:
    
    value - Octet array containing bits to be encoded
    
    offset - Starting byte offset in value
    
    bitOffset - Starting bit offset in first byte. Pass 0 to begin encoding with the most significant bit. Pass 7 to begin with the least significant bit.
    
    nbits - Number of bits to encode
  - encodeBits
```
public void encodeBits(byte[] value,
                       int offset,
                       int nbits)
                throws Asn1InvalidArgException
```
    This method encodes bit values from an array of octets. The ident argument which is used for tracing is defaulted to 'value'.
    
    Specified by:
    
    encodeBits in interface Asn1PerEncoder
    
    Overrides:
    
    encodeBits in class Asn1EncodeBitBuffer
    
    Parameters:
    
    value - Octet array containing bits to be encoded
    
    offset - Starting byte offset in value
    
    nbits - Number of bits to encode
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeCharString
```
public void encodeCharString(java.lang.String value,
                             int nchars,
                             int offset,
                             int abpc,
                             int ubpc,
                             Asn1CharSet charSet)
                      throws Asn1Exception
```
    This method encodes the contents of a known-multiplier character string type. This version assumes a permitted alphabet constraint was specified.
    
    Specified by:
    
    encodeCharString in interface Asn1PerEncoder
    
    Parameters:
    
    value - String containing characters to encode
    
    nchars - Number of characters from string to encode
    
    offset - Offset to first char in string to encode
    
    abpc - Number of bits per character (aligned)
    
    ubpc - Number of bits per character (unaligned)
    
    charSet - Object representing permitted alphabet constraint character set (optional)
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeConsWholeNumber
```
public void encodeConsWholeNumber(long adjustedValue,
                                  long rangeValue,
                                  java.lang.String ident)
                           throws Asn1InvalidArgException
```
    This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard.
    
    Specified by:
    
    encodeConsWholeNumber in interface Asn1PerEncoder
    
    Parameters:
    
    adjustedValue - Adjusted value to be encoded = value - lower range endpoint value. Negative values are interpreted as unsigned integers.
    
    rangeValue - upper - lower + 1. Negative values are interpreted as unsigned integers. Zero is used to represent 2^64.
    
    ident - Tracing identifier
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeConsWholeNumber
```
public void encodeConsWholeNumber(long adjustedValue,
                                  long rangeValue)
                           throws Asn1InvalidArgException
```
    This method implements the rules to encode a constrained whole number as specified in section 10.5 of the X.691 standard. The ident argument which is used for tracing is defaulted to 'value'.
    
    Specified by:
    
    encodeConsWholeNumber in interface Asn1PerEncoder
    
    Parameters:
    
    adjustedValue - Adjusted value to be encoded = value - lower range endpoint value
    
    rangeValue - upper - lower + 1. Negative values are interpreted as unsigned integers. Zero is used to represent 2^64.
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeInt
```
public void encodeInt(long value,
                      int nbits,
                      java.lang.String ident)
               throws Asn1InvalidArgException
```
    This method encodes bit values from an integer value. The least significant bits from the integer are encoded.
    
    Specified by:
    
    encodeInt in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer containing bits to be encoded
    
    nbits - Number of bits to encode
    
    ident - Tracing identifier
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeInt
```
public void encodeInt(long value,
                      int nbits)
               throws Asn1InvalidArgException
```
    This method encodes bit values from an integer value. The least significant bits from the integer are encoded. The ident argument which is used for tracing is defaulted to 'value'.
    
    Specified by:
    
    encodeInt in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer containing bits to be encoded
    
    nbits - Number of bits to encode
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeInt
```
public void encodeInt(long value,
                      boolean encodeLen,
                      boolean signExtend,
                      java.lang.String ident)
               throws Asn1InvalidArgException
```
    This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard.
    
    Specified by:
    
    encodeInt in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer value to be encoded
    
    encodeLen - Flag indicating length determinant should be encoded before encoding integer value.
    
    signExtend - Flag indicating if sign extension should be performed.
    
    ident - Tracing identifier
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeInt
```
public void encodeInt(long value,
                      boolean encodeLen,
                      boolean signExtend)
               throws Asn1InvalidArgException
```
    This method implements the rules to encode either a non-negative binary integer as specified in section 10.3 or a two's complement binary integer as specified in section 10.4 of the X.691 standard. The ident argument which is used for tracing is defaulted to 'value'.
    
    Specified by:
    
    encodeInt in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer value to be encoded
    
    encodeLen - Flag indicating length determinant should be encoded before encoding integer value.
    
    signExtend - Flag indicating if sign extension should be performed.
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeLength
```
public long encodeLength(long value)
                  throws Asn1InvalidArgException
```
    This method encodes either a constrained or unconstrained length depending on whether a size constraint object is set in this object.
    
    Specified by:
    
    encodeLength in interface Asn1PerEncoder
    
    Parameters:
    
    value - Length value to be encoded
    
    Returns:
    
    Value that was actually encoded. This may be less than the value that was passed in if fragementation was done (i.e the value was >= 16k).
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeUnconsLength
```
public long encodeUnconsLength(long value)
                        throws Asn1InvalidArgException
```
    This method encodes a general (unconstrained) length determinant value as described in section 10.9 or the X.691 standard.
    
    Parameters:
    
    value - Length value to be encoded
    
    Returns:
    
    Value that was actually encoded. This may be less than the value that was passed in if fragementation was done (i.e the value was >= 16k).
    
    Throws:
    
    Asn1InvalidArgException
  - encodeLength
```
public void encodeLength(long value,
                         long lower,
                         long upper)
                  throws Asn1Exception
```
    This method encodes a constrained length determinant value. This method should not be used when fragmentation is called for (ie, upper >= 64K and value >= 16K). See encodeLength(value) instead.
    
    Specified by:
    
    encodeLength in interface Asn1PerEncoder
    
    Parameters:
    
    value - Length value to be encoded
    
    lower - Lower bound (inclusive) of length value range
    
    upper - Upper bound (inclusive) of length value range
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeLengthEOM
```
public void encodeLengthEOM(long value)
```
    This method checks to see if a zero byte needs to be added after a fragmented length has been encoded. It will add it to the byte stream if necessary.
    
    Specified by:
    
    encodeLengthEOM in interface Asn1PerEncoder
    
    Parameters:
    
    value - Original length value that was encoded.
  - encodeOIDLengthAndValue
```
public void encodeOIDLengthAndValue(int[] value)
                             throws Asn1Exception
```
    This method encodes the length and contents of an object identifier value.
    
    Specified by:
    
    encodeOIDLengthAndValue in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer array containing arcs to encode
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeRelOIDLengthAndValue
```
public void encodeRelOIDLengthAndValue(int[] value)
                                throws Asn1Exception
```
    This method encodes the length and contents of a relative object identifier value.
    
    Specified by:
    
    encodeRelOIDLengthAndValue in interface Asn1PerEncoder
    
    Parameters:
    
    value - Integer array containing arcs to encode
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeOctetString
```
public void encodeOctetString(byte[] value,
                              int offset,
                              int nbytes)
                       throws Asn1Exception
```
    This method encodes the given array of bytes as an unconstrained octet string value.
    
    Specified by:
    
    encodeOctetString in interface Asn1PerEncoder
    
    Parameters:
    
    value - Byte array containing data to encode. This is assumed to contain a previously encoded PER component.
    
    offset - Starting offset in byte array value
    
    nbytes - Number of bytes to encode
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeOpenType
```
public void encodeOpenType(byte[] value,
                           int offset,
                           int nbytes)
                    throws Asn1Exception
```
    This method encodes the given array of bytes as an open type.
    
    Specified by:
    
    encodeOpenType in interface Asn1PerEncoder
    
    Parameters:
    
    value - Byte array containing data to encode. This is assumed to contain a previously encoded PER component.
    
    offset - Starting offset in byte array value
    
    nbytes - Number of bytes to encode
    
    Throws:
    
    Asn1Exception - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeOpenType
```
public void encodeOpenType(Asn1PerEncodeBuffer buffer,
                           java.lang.String elemName)
                    throws Asn1Exception
```
    This overloaded version of encodeOpenType will encode the componet in the given PER encode buffer into this PER encode buffer.
    
    Parameters:
    
    buffer - PER encode buffer containing encoded message component.
    
    elemName - Name of element being encoded.
    
    Throws:
    
    Asn1Exception
  - encodeSmallLength
```
public void encodeSmallLength(int value)
                       throws Asn1InvalidArgException
```
    This method implements the rules to encode a normally small length as specified in section 11.9 of the X.691 standard.
    
    Specified by:
    
    encodeSmallLength in interface Asn1PerEncoder
    
    Parameters:
    
    value - Value to be encoded
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - encodeSmallNonNegWholeNumber
```
public void encodeSmallNonNegWholeNumber(int value)
                                  throws Asn1InvalidArgException
```
    This method implements the rules to encode a small non-negative whole number as specified in section 10.6 of the X.691 standard.
    
    Specified by:
    
    encodeSmallNonNegWholeNumber in interface Asn1PerEncoder
    
    Parameters:
    
    value - Value to be encoded
    
    Throws:
    
    Asn1InvalidArgException - Any exception thrown by the underlying Asn1PerEncodeBuffer.
  - isAligned
```
public boolean isAligned()
```
    This method is used to test if PER aligned encoding has been specified.
    
    Specified by:
    
    isAligned in interface Asn1PerMessageBuffer
  - setAligned
```
public void setAligned(boolean value)
```
    This method is used to turn PER aligned encoding on or off
  - setSizeConstraint
```
public void setSizeConstraint(long lower,
                              long upper)
```
    This method is used to set a size constraint within the buffer object. The constraint will only be set if an existing constraint is not already in place (i.e. if the existing reference is not null). This is used for length encoding of SEQUENCE OF objects to pass constraints applied to referenced objects to the base object.
    
    Parameters:
    
    lower - Lower bound of root constraint
    
    upper - Upper bound of root constraint
  - setSizeConstraintExt
```
public void setSizeConstraintExt(long lower,
                                 long upper,
                                 long extLower,
                                 long extUpper)
```
    This method is used to set an extensible size constraint within the buffer object. The constraint will only be set if an existing constraint is not already in place (i.e. if the existing reference is not null). This is used for length encoding of SEQUENCE OF objects to pass constraints applied to referenced objects to the base object.
    
    Parameters:
    
    lower - Lower bound of root constraint
    
    upper - Upper bound of root constraint
    
    extLower - Lower bound of extension constraint
    
    extUpper - Upper bound of extension constraint

Class Asn1PerEncodeBuffer

Field Summary

Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

Fields inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer

Fields inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase

Constructor Summary

Method Summary

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBitBuffer

Methods inherited from class com.objsys.asn1j.runtime.Asn1EncodeBuffer

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBuffer

Methods inherited from class com.objsys.asn1j.runtime.Asn1MessageBufferBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.objsys.asn1j.runtime.Asn1BitMessageBuffer

Methods inherited from interface com.objsys.asn1j.runtime.Asn1PerEncoder

Constructor Detail

Asn1PerEncodeBuffer

Asn1PerEncodeBuffer

Method Detail

byteAlign

encodeBit

encodeBit

encodeBits

encodeBits

encodeBits

encodeBits

encodeCharString

encodeConsWholeNumber

encodeConsWholeNumber

encodeInt

encodeInt

encodeInt

encodeInt

encodeLength

encodeUnconsLength

encodeLength

encodeLengthEOM

encodeOIDLengthAndValue

encodeRelOIDLengthAndValue

encodeOctetString

encodeOpenType

encodeOpenType

encodeSmallLength

encodeSmallNonNegWholeNumber

isAligned

setAligned

setSizeConstraint

setSizeConstraintExt