StringPropertyDefinition.java revision a94c41b1759c23f849376a5f5448bc6e819f1c11
/*
* 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 2008 Sun Microsystems, Inc.
*/
/**
* String property definition.
*/
/**
* An interface for incrementally constructing string property definitions.
*/
// Flag indicating whether values of this property are
// case-insensitive.
private boolean isCaseInsensitive = true;
// Optional pattern which values of this property must match.
// Pattern usage which provides a user-friendly summary of the
// pattern if present.
// Private constructor
super(d, propertyName);
}
/**
* Set a flag indicating whether values of this property are
* case-insensitive.
*
* @param value
* <code>true</code> if values are case-insensitive, or
* <code>false</code> otherwise.
*/
public final void setCaseInsensitive(boolean value) {
}
/**
* Set the regular expression pattern which values of this property must
* match. By default there is no pattern defined.
*
* @param pattern
* The regular expression pattern string, or
* <code>null</code> if there is no pattern.
* @param patternUsage
* A user-friendly usage string representing the pattern
* which can be used in error messages and help (e.g. for
* string "HOST:PORT" would be appropriate).
* @throws PatternSyntaxException
* If the provided regular expression pattern has an invalid
* syntax.
*/
this.patternUsage = null;
} else {
this.patternUsage = patternUsage;
}
}
/**
* {@inheritDoc}
*/
}
}
/**
* Create a string property definition builder.
*
* @param d
* The managed object definition associated with this property
* definition.
* @param propertyName
* The property name.
* @return Returns the new string property definition builder.
*/
return new Builder(d, propertyName);
}
// Flag indicating whether values of this property are
// case-insensitive.
private final boolean isCaseInsensitive;
// Optional pattern which values of this property must match.
// Pattern usage which provides a user-friendly summary of the
// pattern if present.
private final String patternUsage;
// Private constructor.
this.isCaseInsensitive = isCaseInsensitive;
this.patternUsage = patternUsage;
}
/**
* {@inheritDoc}
*/
public <R, P> R accept(PropertyDefinitionVisitor<R, P> v, P p) {
return v.visitString(this, p);
}
/**
* {@inheritDoc}
*/
return v.visitString(this, value, p);
}
/**
* {@inheritDoc}
*/
try {
} catch (PropertyException e) {
}
return value;
}
/**
* Gets the optional regular expression pattern which values of this
* property must match.
*
* @return Returns the optional regular expression pattern which values of
* this property must match, or <code>null</code> if there is no
* pattern.
*/
public Pattern getPattern() {
return pattern;
}
/**
* Gets the pattern synopsis of this string property definition in the
* default locale.
*
* @return Returns the pattern synopsis of this string property definition
* in the default locale, or <code>null</code> if there is no
* pattern synopsis (which is the case when there is no pattern
* matching defined for this string property definition).
*/
public LocalizableMessage getPatternSynopsis() {
}
/**
* Gets the optional pattern synopsis of this string property definition in
* the specified locale.
*
* @param locale
* The locale.
* @return Returns the pattern synopsis of this string property definition
* in the specified locale, or <code>null</code> if there is no
* pattern synopsis (which is the case when there is no pattern
* matching defined for this string property definition).
*/
try {
} catch (MissingResourceException e) {
return null;
}
}
/**
* Gets a user-friendly usage string representing the pattern which can be
* used in error messages and help (e.g. for patterns which match a
* appropriate).
*
* @return Returns the user-friendly pattern usage string, or
* <code>null</code> if there is no pattern.
*/
public String getPatternUsage() {
return patternUsage;
}
/**
* Query whether values of this property are case-insensitive.
*
* @return Returns <code>true</code> if values are case-insensitive, or
* <code>false</code> otherwise.
*/
public boolean isCaseInsensitive() {
return isCaseInsensitive;
}
/**
* {@inheritDoc}
*/
if (isCaseInsensitive()) {
} else {
}
}
/**
* {@inheritDoc}
*/
}
}
}
}