{@link org.apache.xerces.xs.XSSimpleTypeDefinition} defines constants for various facets
+ * + * @return a bit-combination of allowed facets + * + * @see org.apache.xerces.xs.XSSimpleTypeDefinition + */ public abstract short getAllowedFacets(); - // convert a string to an actual value. for example, - // for number types (decimal, double, float, and types derived from them), - // get the BigDecimal, Double, Flout object. - // for some types (string and derived), they just return the string itself + /** + * Converts a string to an actual value. + *For example: for number types (decimal, double, float, and types derived from them), + * get the BigDecimal, Double, or Float objects. + * For string and derived types, they just return the string itself. + *
+ * + * @param content the string value that needs to be converted to an actual value + * @param context the validation context + * + * @throws InvalidDatatypeValueException if the content is invalid + */ public abstract Object getActualValue(String content, ValidationContext context) throws InvalidDatatypeValueException; - // for ID/IDREF/ENTITY types, do some extra checking after the value is - // checked to be valid with respect to both lexical representation and - // facets + /** + * Check extra rules. + *For ID, IDREF, and ENTITY types, do some extra checking after the value is checked + * to be valid with respect to both lexical representation and facets.
+ * + * @param value the value for which additional checks will be made + * @param context the validation context + * + * @throws InvalidDatatypeValueException if the value is invalid + */ public void checkExtraRules(Object value, ValidationContext context) throws InvalidDatatypeValueException { } @@ -74,23 +97,44 @@ public void checkExtraRules(Object value, ValidationContext context) throws Inva public static final short EQUAL = 0; public static final short GREATER_THAN = 1; public static final short INDETERMINATE = 2; - - // where there is distinction between identity and equality, this method - // will be overwritten - // checks whether the two values are identical; for ex, this distinguishes - // -0.0 from 0.0 + + /** + * Is identical checks whether the two values are identical. + *For example; this distinguishes -0.0 from 0.0
+ *Where there is distinction between identity and equality, this method will + * be overwritten.
+ * + * @param value1 a value to compare + * @param value2 a value to compare + * @return true if the values are identical + */ public boolean isIdentical (Object value1, Object value2) { return value1.equals(value2); } - // check the order relation between the two values - // the parameters are in compiled form (from getActualValue) + /** + * Checks the order relation between two values. + *The parameters are in compiled form (from {@link #getActualValue(String, ValidationContext)})
+ *This class should be overridden with the first value calling compareTo() with
+ * the second value.
Note: The default behaviour in TypeValidator is to return -1
+ * + * @param value1 a value to compare + * @param value2 a value to compare + * @return either -1, 0, or 1 to indicate if the first arg should be considered before, same, or after the second arg + */ + // note that this exists because Xerces predates JDK 1.2, should really use java.lang.Comparable now public int compare(Object value1, Object value2) { return -1; } - // get the length of the value - // the parameters are in compiled form (from getActualValue) + /** + * Get the length of the value. + *The parameters are in compiled form (from {@link #getActualValue(String, ValidationContext)})
+ * + * @param value the data to check + * @return the length of the value + */ public int getDataLength(Object value) { if (value instanceof String) { final String str = (String)value; @@ -102,14 +146,24 @@ public int getDataLength(Object value) { return -1; } - // get the number of digits of the value - // the parameters are in compiled form (from getActualValue) + /** + * Get the number of digits of the value. + *The parameters are in compiled form (from {@link #getActualValue(String, ValidationContext)})
+ * + * @param value the data to check + * @return the number of digits of the value + */ public int getTotalDigits(Object value) { return -1; } - // get the number of fraction digits of the value - // the parameters are in compiled form (from getActualValue) + /** + * Get the number of fraction digits of the value. + *The parameters are in compiled form (from {@link #getActualValue(String, ValidationContext)})
+ * + * @param value the data to check + * @return the number of fraction digits of the value + */ public int getFractionDigits(Object value) { return -1; } @@ -133,13 +187,24 @@ private int getCodePointLength(String value) { return len - surrogatePairCount; } - // check whether the character is in the range 0x30 ~ 0x39 + /** + * Check whether the char is a digit or not + *check whether the character is in the range 0x30 ~ 0x39
If the character is in the range 0x30 ~ 0x39, return its int value (0~9), otherwise, return -1