AttributeValueTag.java revision b1dce270ec218b8ad86ce6d745d295da038a5c88
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014 ForgeRock AS
*/
/**
* This class defines a tag that is used to reference the value of a specified
* attribute already defined in the entry.
*/
public class AttributeValueTag
extends Tag
{
// The attribute type that specifies which value should be used.
private AttributeType attributeType;
// The maximum number of characters to include from the value.
private int numCharacters;
/**
* Creates a new instance of this attribute value tag.
*/
public AttributeValueTag()
{
numCharacters = 0;
}
/**
* Retrieves the name for this tag.
*
* @return The name for this tag.
*/
{
return "AttributeValue";
}
/**
* Indicates whether this tag is allowed for use in the extra lines for
* branches.
*
* @return <CODE>true</CODE> if this tag may be used in branch definitions,
* or <CODE>false</CODE> if not.
*/
public boolean allowedInBranch()
{
return true;
}
/**
* Performs any initialization for this tag that may be needed while parsing
* a branch definition.
*
* @param templateFile The template file in which this tag is used.
* @param branch The branch in which this tag is used.
* @param arguments The set of arguments provided for this tag.
* @param lineNumber The line number on which this tag appears in the
* template file.
* @param warnings A list into which any appropriate warning messages
* may be placed.
*
* @throws InitializationException If a problem occurs while initializing
* this tag.
*/
throws InitializationException
{
{
throw new InitializationException(message);
}
{
throw new InitializationException(message);
}
{
try
{
if (numCharacters < 0)
{
throw new InitializationException(message);
}
}
catch (NumberFormatException nfe)
{
throw new InitializationException(message);
}
}
else
{
numCharacters = 0;
}
}
/**
* Performs any initialization for this tag that may be needed while parsing
* a template definition.
*
* @param templateFile The template file in which this tag is used.
* @param template The template in which this tag is used.
* @param arguments The set of arguments provided for this tag.
* @param lineNumber The line number on which this tag appears in the
* template file.
* @param warnings A list into which any appropriate warning messages
* may be placed.
*
* @throws InitializationException If a problem occurs while initializing
* this tag.
*/
throws InitializationException
{
{
throw new InitializationException(message);
}
{
throw new InitializationException(message);
}
{
try
{
if (numCharacters < 0)
{
throw new InitializationException(message);
}
}
catch (NumberFormatException nfe)
{
throw new InitializationException(message);
}
}
else
{
numCharacters = 0;
}
}
/**
* Generates the content for this tag by appending it to the provided tag.
*
* @param templateEntry The entry for which this tag is being generated.
* @param templateValue The template value to which the generated content
* should be appended.
*
* @return The result of generating content for this tag.
*/
{
if (v == null)
{
// This is fine -- we just won't append anything.
return TagResult.SUCCESS_RESULT;
}
if (numCharacters > 0)
{
{
}
else
{
}
}
else
{
}
return TagResult.SUCCESS_RESULT;
}
}