Class SEQUENCE.Template

  • All Implemented Interfaces:
    ASN1Template
    Direct Known Subclasses:
    Encoding.Template
    Enclosing class:
    SEQUENCE

    public static class SEQUENCE.Template
    extends java.lang.Object
    implements ASN1Template
    A class for constructing a SEQUENCE from its BER encoding. It is an ordered collection of sub-templates. Each sub-template can be marked optional, or a default value can be given.
    • Constructor Detail

      • Template

        public Template()
    • Method Detail

      • addElement

        public void addElement​(ASN1Template t)
        Adds a sub-template to the end of this SEQUENCE template. For example, if the ASN.1 included:
         MySequence ::= SEQUENCE {
              item        SubType,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addElement( new SubType.Template() );
         
        Parameters:
        t - Sub-template.
      • insertElementAt

        public void insertElementAt​(ASN1Template t,
                                    int index)
        Inserts the template at the given index.
        Parameters:
        t - Sub-template.
        index - Index.
      • addElement

        public void addElement​(Tag implicitTag,
                               ASN1Template t)
        Adds a sub-template to the end of this SEQUENCE template, with the given implicit tag. For example, if the ASN.1 were:
         MySequence ::= SEQUENCE {
              item        [0] IMPLICIT  SubType,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addElement( new Tag(0), new SubType.Template());
         
        Parameters:
        implicitTag - Implicit tag.
        t - Sub-template.
      • insertElementAt

        public void insertElementAt​(Tag implicit,
                                    ASN1Template t,
                                    int index)
        Inserts the template with the given implicit tag at the given index.
        Parameters:
        implicit - Implicit tag.
        t - Sub-Template.
        index - Index.
      • addOptionalElement

        public void addOptionalElement​(ASN1Template t)
        Adds an optional sub-template. For example, if the ASN.1 were:
         MySequence ::= SEQUENCE {
              item        SubType OPTIONAL,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addOptionalElement( new SubType.Template() );
         
        Parameters:
        t - Optional sub-template.
      • insertOptionalElementAt

        public void insertOptionalElementAt​(ASN1Template t,
                                            int index)
        Inserts the optional template at the given index.
        Parameters:
        t - Optional sub-template.
        index - Index.
      • addOptionalElement

        public void addOptionalElement​(Tag implicitTag,
                                       ASN1Template t)
        Adds an optional sub-template with an implicit tag. For example, if the ASN.1 were:
         MySequence ::= SEQUENCE {
              item        [0] IMPLICIT SubType OPTIONAL,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addOptionalElement( new SubType.Template() );
         
        Parameters:
        implicitTag - Implicit tag.
        t - Optional sub-template.
      • insertOptionalElementAt

        public void insertOptionalElementAt​(Tag implicit,
                                            ASN1Template t,
                                            int index)
        Inserts the optional template with the given default value at the given index.
        Parameters:
        implicit - Implicit tag.
        t - Optional sub-template.
        index - Index.
      • addElement

        public void addElement​(ASN1Template t,
                               ASN1Value def)
        Adds a sub-template with a default value. For example, if the ASN.1 were:
         MySequence ::= SEQUENCE {
              version     INTEGER DEFAULT 1,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addElement( new INTEGER.Template(), new INTEGER(1) );
         
        Parameters:
        t - Sub-template.
        def - The default value for this field, which will be used if no value is supplied by the encoded structure. It must be of the same type as what the template would produce.
      • insertElementAt

        public void insertElementAt​(ASN1Template t,
                                    ASN1Value def,
                                    int index)
        Inserts the template with the given default value at the given index.
        Parameters:
        t - Sub-template.
        def - Default value.
        index - Index.
      • addElement

        public void addElement​(Tag implicitTag,
                               ASN1Template t,
                               ASN1Value def)
        Adds a sub-template with a default value and an implicit tag. For example, if the ASN.1 were:
         MySequence ::= SEQUENCE {
              version     [0] IMPLICIT INTEGER DEFAULT 1,
              ... }
         
        the "item" element would be added to the MySequence template with:
          mySequence.addElement( new Tag(0), new INTEGER.Template(),
              new INTEGER(1) );
         
        Parameters:
        implicitTag - Implicit tag.
        t - Sub-template.
        def - The default value for this field, which will be used if no value is supplied by the encoded structure. It must be of the same type as what the template would produce.
      • insertElementAt

        public void insertElementAt​(Tag implicit,
                                    ASN1Template t,
                                    ASN1Value def,
                                    int index)
        Inserts the template with the given implicit tag and given default value at the given index.
        Parameters:
        implicit - Implicit tag.
        t - Sub-template.
        def - Default value.
        index - Index.
      • implicitTagAt

        public Tag implicitTagAt​(int index)
        Returns the implicit tag of the item stored at the given index. May be NULL if no implicit tag was specified.
        Parameters:
        index - Index.
        Returns:
        Tag.
      • templateAt

        public ASN1Template templateAt​(int index)
        Returns the sub-template stored at the given index.
        Parameters:
        index - Index.
        Returns:
        Sub-template.
      • isOptionalAt

        public boolean isOptionalAt​(int index)
        Returns whether the sub-template at the given index is optional.
        Parameters:
        index - Index.
        Returns:
        True if the sub-template is optional.
      • defaultAt

        public ASN1Value defaultAt​(int index)
        Returns the default value for the sub-template at the given index. May return NULL if no default value was specified.
        Parameters:
        index - Index.
        Returns:
        Default value.
      • size

        public int size()
        Returns:
        The number of elements in this SEQUENCE template.
      • removeAllElements

        public void removeAllElements()
        Removes all sub-templates from this SEQUENCE template.
      • removeElementAt

        public void removeElementAt​(int index)
        Removes the sub-template at the given index.
        Parameters:
        index - Index.
      • tagMatch

        public boolean tagMatch​(Tag tag)
        Description copied from interface: ASN1Template
        Determines whether the given tag will satisfy this template.
        Specified by:
        tagMatch in interface ASN1Template
        Parameters:
        tag - Tag.
        Returns:
        True if the given tag will satisfy this template.
      • decode

        public ASN1Value decode​(java.io.InputStream istream)
                         throws java.io.IOException,
                                InvalidBERException
        Decodes a SEQUENCE from its BER encoding.
        Specified by:
        decode in interface ASN1Template
        Parameters:
        istream - Input stream.
        Returns:
        ASN.1 value.
        Throws:
        java.io.IOException - If other error occurred.
        InvalidBERException - If there is an invalid BER encoding.
      • decode

        public ASN1Value decode​(Tag tag,
                                java.io.InputStream istream)
                         throws java.io.IOException,
                                InvalidBERException
        Decodes a SEQUENCE from its BER encoding, where the SEQUENCE itself has an implicit tag.
        Specified by:
        decode in interface ASN1Template
        Parameters:
        tag - Tag.
        istream - Input stream.
        Returns:
        ASN.1 value.
        Throws:
        java.io.IOException - If other error occurred.
        InvalidBERException - If there is an invalid BER encoding.