001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2009-2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.asn1;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.Mutable;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class provides a data structure which is used in the course of writing
051 * an ASN.1 sequence to an ASN.1 buffer.  It keeps track of the position at
052 * which the sequence value begins so that the appropriate length may be
053 * inserted after all embedded elements have been added.  The {@link #end}
054 * method must be called after all elements have been added to ensure that the
055 * length is properly computed and inserted into the associated buffer.
056 */
057@Mutable()
058@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
059public final class ASN1BufferSequence
060       implements Serializable
061{
062  /**
063   * The serial version UID for this serializable class.
064   */
065  private static final long serialVersionUID = 7219098399193345629L;
066
067
068
069  // The ASN.1 buffer with which the sequence is associated.
070  @NotNull private final ASN1Buffer buffer;
071
072  // The position in the ASN.1 buffer at which the first sequence value begins.
073  private final int valueStartPos;
074
075
076
077  /**
078   * Creates a new instance of this class for the provided ASN.1 buffer.
079   *
080   * @param  buffer  The ASN.1 buffer with which this object will be associated.
081   */
082  ASN1BufferSequence(@NotNull final ASN1Buffer buffer)
083  {
084    this.buffer = buffer;
085
086    valueStartPos = buffer.length();
087  }
088
089
090
091  /**
092   * Updates the associated ASN.1 buffer to indicate that all sequence elements
093   * have been added and that the appropriate length should be inserted.
094   */
095  public void end()
096  {
097    buffer.endSequenceOrSet(valueStartPos);
098  }
099}