001/*
002 * Copyright 2008-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-2024 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) 2008-2024 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.util;
037
038
039
040import com.unboundid.asn1.ASN1OctetString;
041
042
043
044/**
045 * This class provides a mechanism for creating {@link ByteString} values.
046 */
047@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
048public final class ByteStringFactory
049{
050  /**
051   * A pre-allocated ASN.1 octet string with no value.
052   */
053  @NotNull private static final ASN1OctetString EMPTY_VALUE =
054       new ASN1OctetString();
055
056
057
058  /**
059   * Prevent this class from being instantiated.
060   */
061  private ByteStringFactory()
062  {
063    // No implementation required.
064  }
065
066
067
068  /**
069   * Creates a new byte string with no value.
070   *
071   * @return  The created byte string.
072   */
073  @NotNull()
074  public static ByteString create()
075  {
076    return EMPTY_VALUE;
077  }
078
079
080
081  /**
082   * Creates a new byte string with the provided value.
083   *
084   * @param  value  The value to use for the byte string.
085   *
086   * @return  The created byte string.
087   */
088  @NotNull()
089  public static ByteString create(@Nullable final byte[] value)
090  {
091    return new ASN1OctetString(value);
092  }
093
094
095
096  /**
097   * Creates a new byte string with the provided value.
098   *
099   * @param  value   The byte array containing the data to use for the value.
100   *                 It must not be {@code null}.
101   * @param  offset  The position in the array at which the value begins.  It
102   *                 must be greater than or equal to zero and less or equal to
103   *                 the end of the array.
104   * @param  length  The number of bytes contained in the value.  It must be
105   *                 greater than or equal to zero, and the sum of the offset
106   *                 and the length must be less than or equal to the end of the
107   *                 array.
108   *
109   * @return  The created byte string.
110   */
111  @NotNull()
112  public static ByteString create(@NotNull final byte[] value, final int offset,
113                                  final int length)
114  {
115    return new ASN1OctetString(value, offset, length);
116  }
117
118
119
120  /**
121   * Creates a new byte string with the provided value.
122   *
123   * @param  value  The value to use for the byte string.
124   *
125   * @return  The created byte string.
126   */
127  @NotNull()
128  public static ByteString create(@Nullable final String value)
129  {
130    return new ASN1OctetString(value);
131  }
132}