001/* 002 * Copyright 2008-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2008-2020 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-2020 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 private static final ASN1OctetString EMPTY_VALUE = new ASN1OctetString(); 054 055 056 057 /** 058 * Prevent this class from being instantiated. 059 */ 060 private ByteStringFactory() 061 { 062 // No implementation required. 063 } 064 065 066 067 /** 068 * Creates a new byte string with no value. 069 * 070 * @return The created byte string. 071 */ 072 public static ByteString create() 073 { 074 return EMPTY_VALUE; 075 } 076 077 078 079 /** 080 * Creates a new byte string with the provided value. 081 * 082 * @param value The value to use for the byte string. 083 * 084 * @return The created byte string. 085 */ 086 public static ByteString create(final byte[] value) 087 { 088 return new ASN1OctetString(value); 089 } 090 091 092 093 /** 094 * Creates a new byte string with the provided value. 095 * 096 * @param value The byte array containing the data to use for the value. 097 * It must not be {@code null}. 098 * @param offset The position in the array at which the value begins. It 099 * must be greater than or equal to zero and less or equal to 100 * the end of the array. 101 * @param length The number of bytes contained in the value. It must be 102 * greater than or equal to zero, and the sum of the offset 103 * and the length must be less than or equal to the end of the 104 * array. 105 * 106 * @return The created byte string. 107 */ 108 public static ByteString create(final byte[] value, final int offset, 109 final int length) 110 { 111 return new ASN1OctetString(value, offset, length); 112 } 113 114 115 116 /** 117 * Creates a new byte string with the provided value. 118 * 119 * @param value The value to use for the byte string. 120 * 121 * @return The created byte string. 122 */ 123 public static ByteString create(final String value) 124 { 125 return new ASN1OctetString(value); 126 } 127}