com.unboundid.util.ValuePatternComponent Maven / Gradle / Ivy
/*
* Copyright 2008-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2021 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2021 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.util;
import java.io.Serializable;
/**
* This class defines an element that may be used to generate a portion of the
* string representation of a {@link ValuePattern}. All value pattern component
* implementations must be completely threadsafe.
*/
@NotExtensible()
abstract class ValuePatternComponent
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -5740038096026337244L;
/**
* Appends a string representation of the next value generated by this
* component to the provided buffer.
*
* @param buffer The buffer to which the value should be appended.
*/
abstract void append(@NotNull StringBuilder buffer);
/**
* Indicates whether this value pattern component may be targeted by a back
* reference.
*
* @return {@code true} if this value pattern component may be targeted by a
* back reference, or {@code false} if not.
*/
abstract boolean supportsBackReference();
}