Name: rmT116609 Date: 02/03/2002


FULL PRODUCT VERSION :
java version "1.4.0-rc"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-rc-b91)
Java HotSpot(TM) Client VM (build 1.4.0-rc-b91, mixed mode)



DESCRIPTION OF THE PROBLEM :

In the java doc for java.util.regex.Pattern

http://java.sun.com/j2se/1.4/docs/api/java/util/regex/Pattern.html

the explanation of flags is insufficient:

(?idmsux-idmsux) Nothing, but turns match flags on - off
(?idmsux-idmsux:X) X, as a non-capturing group with the given flags on - off

In particular, it does not explain what 'idmsux' means, nor where to find out.

I suggest the word 'flags' be a link to a new explanation of what 'idmsux' flags are, perhaps a table underneath. At minimum, mention that the flags correspond to the flags parameter described in the compile method. [Many weeks after being confused by this, I found the correspondance from CONSTANT to ?char is described under each constant field; there needs to be a cross referenced table from ?char
to CONSTANT for people who need to read regular expressions and want to know what a ?char means.]

flags - Match flags, a bit mask that may include
CASE_INSENSITIVE, MULTILINE, DOTALL, UNICODE_CASE, and CANON_EQ

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
See
http://java.sun.com/j2se/1.4/docs/api/java/util/regex/Pattern.html


find text

?idmsux-idmsux) Nothing, but turns match flags on - off
(?idmsux-idmsux:X) X, as a non-capturing group with the given flags on - off

EXPECTED VERSUS ACTUAL BEHAVIOR :

Expected: explanation of 'idmsux'.

Actual: no explanation of 'idmsux'; it is not even clear that it is not an acronym, but several indpendent characters.


CUSTOMER WORKAROUND :
Scan through the FIELDS, where each constant has a description of what the constant flag does, and what its ?char is.
(Review ID: 139133)
======================================================================