TeletexTerminalIdentifierSyntax.java revision 7185b49f58c4cdb16d035ecc45e38ec9b1cd9bd0
/*
* 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
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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.
*/
/**
* This class implements the teletex terminal identifier attribute syntax, which
* contains a printable string (the terminal identifier) followed by zero or
* more parameters, which start with a dollar sign and are followed by a
* parameter name, a colon, and a value. The parameter value should consist of
* any string of bytes (the dollar sign and backslash must be escaped with a
* preceding backslash), and the parameter name must be one of the following
* strings:
* <UL>
* <LI>graphic</LI>
* <LI>control</LI>
* <LI>misc</LI>
* <LI>page</LI>
* <LI>private</LI>
* </UL>
*/
public class TeletexTerminalIdentifierSyntax
extends AttributeSyntax<AttributeSyntaxCfg>
{
/**
* The set of allowed fax parameter values, formatted entirely in lowercase
* characters.
*/
static
{
}
// The default equality matching rule for this syntax.
// The default ordering matching rule for this syntax.
// The default substring matching rule for this syntax.
/**
* Creates a new instance of this syntax. Note that the only thing that
* should be done here is to invoke the default constructor for the
* superclass. All initialization should be performed in the
* <CODE>initializeSyntax</CODE> method.
*/
public TeletexTerminalIdentifierSyntax()
{
super();
}
/**
* {@inheritDoc}
*/
throws ConfigException
{
if (defaultEqualityMatchingRule == null)
{
}
if (defaultOrderingMatchingRule == null)
{
}
if (defaultSubstringMatchingRule == null)
{
}
}
/**
* Retrieves the common name for this attribute syntax.
*
* @return The common name for this attribute syntax.
*/
public String getSyntaxName()
{
return SYNTAX_TELETEX_TERM_ID_NAME;
}
/**
* Retrieves the OID for this attribute syntax.
*
* @return The OID for this attribute syntax.
*/
{
return SYNTAX_TELETEX_TERM_ID_OID;
}
/**
* Retrieves a description for this attribute syntax.
*
* @return A description for this attribute syntax.
*/
public String getDescription()
{
}
/**
* Retrieves the default equality matching rule that will be used for
* attributes with this syntax.
*
* @return The default equality matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if equality
* matches will not be allowed for this type by default.
*/
{
return defaultEqualityMatchingRule;
}
/**
* Retrieves the default ordering matching rule that will be used for
* attributes with this syntax.
*
* @return The default ordering matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if ordering
* matches will not be allowed for this type by default.
*/
{
return defaultOrderingMatchingRule;
}
/**
* Retrieves the default substring matching rule that will be used for
* attributes with this syntax.
*
* @return The default substring matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if substring
* matches will not be allowed for this type by default.
*/
{
return defaultSubstringMatchingRule;
}
/**
* Retrieves the default approximate matching rule that will be used for
* attributes with this syntax.
*
* @return The default approximate matching rule that will be used for
* attributes with this syntax, or <CODE>null</CODE> if approximate
* matches will not be allowed for this type by default.
*/
{
// There is no approximate matching rule by default.
return null;
}
/**
* Indicates whether the provided value is acceptable for use in an attribute
* with this syntax. If it is not, then the reason may be appended to the
* provided buffer.
*
* @param value The value for which to make the determination.
* @param invalidReason The buffer to which the invalid reason should be
* appended.
*
* @return <CODE>true</CODE> if the provided value is acceptable for use with
* this syntax, or <CODE>false</CODE> if not.
*/
{
// Get a lowercase string representation of the value and find its length.
// The value must contain at least one character.
if (valueLength == 0)
{
return false;
}
// The first character must be a printable string character.
if (! PrintableString.isPrintableCharacter(c))
{
return false;
}
// Continue reading until we find a dollar sign or the end of the string.
// Every intermediate character must be a printable string character.
int pos = 1;
{
if (c == '$')
{
pos++;
break;
}
else
{
if (! PrintableString.isPrintableCharacter(c))
{
}
}
}
if (pos >= valueLength)
{
// We're at the end of the value, so it must be valid unless the last
// character was a dollar sign.
if (c == '$')
{
valueString));
return false;
}
else
{
return true;
}
}
// Continue reading until we find the end of the string. Each substring
// must be a valid teletex terminal identifier parameter followed by a colon
// and the value. Dollar signs must be escaped
int paramStartPos = pos;
boolean escaped = false;
while (pos < valueLength)
{
if (escaped)
{
pos++;
continue;
}
if (c == '\\')
{
escaped = true;
continue;
}
else if (c == '$')
{
if (colonPos < 0)
{
valueString));
return false;
}
{
valueString, paramName));
return false;
}
paramStartPos = pos;
}
}
// We must be at the end of the value. Read the last parameter and make
// sure it is valid.
if (colonPos < 0)
{
valueString));
return false;
}
{
valueString, paramName));
return false;
}
// If we've gotten here, then the value must be valid.
return true;
}
/**
* {@inheritDoc}
*/
public boolean isBinary()
{
return false;
}
}