String[] in
48 | *
49 | * @author M Habibi
50 | */
51 | private static void display(String[] in)
52 | {
53 | if (in != null && in[0] != null)
54 | {
55 |
56 | for (int i=0; i String countryCode
42 | * @param the String zip
43 | * @return boolean
44 | *
45 | * @author M Habibi
46 | */
47 | public static boolean isZipValid(String countryCode, String zip)
48 | {
49 | boolean retval=false;
50 | //use the country code for form a unique into the regex
51 | //properties file
52 | String zipPatternKey = ZIP_PATTERN + countryCode.toUpperCase();
53 |
54 | //extract the regex pattern for the given country code
55 | String zipPattern = regexProperties.getProperty(zipPatternKey);
56 |
57 | //if there was some sort of problem, don't bother trying
58 | //to execute the regex
59 | if (zipPattern != null)
60 | retval = zip.trim().matches(zipPattern);
61 | else
62 | {
63 | String msg = "regex for country code "+countryCode;
64 | msg+= " not found in property file ";
65 | log.warning(msg);
66 | }
67 | //create log report
68 | String msg = "regex="+zipPattern +
69 | "\nzip="+zip+"\nCountryCode="+
70 | countryCode+"\nmatch result="+retval;
71 | log.finest(msg);
72 |
73 | return retval;
74 | }
75 | }
--------------------------------------------------------------------------------
/util/GetGroup.java:
--------------------------------------------------------------------------------
1 | import java.util.logging.*;
2 | import java.util.regex.*;
3 |
4 |
5 | /**
6 | * A utility for extracting a specific regex group
7 | * from a given text which is either passed in or in a file.
8 | * Thus, for Java (\w)(\w)(\w).* 3 v is returned.
9 | * Alternately, the input
10 | * "-f" "GetGroup.java" " class\s+(.*)\s+\{" "1"
11 | * would return the name of this Class, "GetGroup"
12 | * @param the String args[]
13 | * @throws Exception
14 | * @author M Habibi
15 | * @version 1.0 2/22/04 6:17 PM
16 | */
17 | public class GetGroup
18 | {
19 | private static Logger log = Logger.getAnonymousLogger();
20 |
21 | /**
22 | * Extracts the indicated Group from the given
23 | * text. Thus, for Java (\w)(\w)(\w).* 3
24 | * v is returned.
25 | * Alternately, the input
26 | * "-f" "GetGroup.java" " class\s+(.*)\s+\{" "1"
27 | * would return the name of this Class, "GetGroup"
28 | * @param the String args[]
29 | * @throws Exception
30 | *
31 | * @author M Habibi
32 | */
33 | public static void main(String args[]) throws Exception
34 | {
35 |
36 | if (args != null && args.length == 3)
37 | {
38 | int groupNum = Integer.parseInt(args[2]);
39 |
40 | findGroup(args[0],args[1],groupNum);
41 |
42 | }
43 | else if(args.length == 4 && args[0].equals("-f")){
44 | String inputString = RegexUtil.getFileContent(args[1]);
45 | int groupNum = Integer.parseInt(args[3]);
46 |
47 | findGroup(inputString,args[2],groupNum);
48 |
49 | }
50 | else
51 | {
52 | String msg = "usage: "Java" "(\w)(\w)(\w).*" "3"
63 | * v is returned.
64 | */
65 | private static void findGroup(String text, String regex, int groupNum)
66 | {
67 | Pattern p = Pattern.compile(regex, Pattern.MULTILINE);
68 |
69 | Matcher m = p.matcher(text);
70 |
71 | if (m.find())
72 | {
73 | String g = m.group(groupNum);
74 |
75 | System.out.println("group find =:"+ g+":");
76 | }
77 |
78 | else
79 | {
80 | log.info("regex=:"+ regex+":");
81 | log.info("groupNum=:"+ groupNum+":");
82 | System.out.println("no matches found");
83 |
84 | }
85 |
86 |
87 |
88 |
89 | }
90 | }
91 |
--------------------------------------------------------------------------------
/chapter5/MatchDates.java:
--------------------------------------------------------------------------------
1 | import java.util.regex.*;
2 | import java.io.*;
3 | import java.util.logging.Logger;
4 | import java.util.GregorianCalendar;
5 | import java.util.Calendar;
6 |
7 | /**
8 | *Matches dates
9 | */
10 | public class MatchDates{
11 | private static final String PROP_FILE = "../regex.properties";
12 | private static Logger log = Logger.getAnonymousLogger();
13 | public static int LOWER_YEAR_LIMIT = -120;
14 |
15 | public static void main(String args[]) throws Exception{
16 | if (args != null && args.length==1)
17 | {
18 | boolean b =isDateValid(args[0]);
19 | log.info(""+b);
20 | }
21 | else
22 | {
23 | System.out.println("usage: java MatchDates dd/dd/dddd");
24 | }
25 | }
26 |
27 | /**
28 | * Confirms that given date format consists of one or two digits
29 | * followed by a punctuation, followed by one or two digits
30 | * followed by a hypen, followed by two or four digits. Further,
31 | * it actually validates that the date is less then today, and
32 | * and not more then LOWER_YEAR_LIMIT =120 years in
33 | * the past. This method even takes leap years and such into account
34 | * @param date a String representing the date.
35 | * @returns true if data format is acceptable.
36 | */
37 | public static boolean isDateValid(String date)
38 | {
39 | boolean retval=false;
40 |
41 | String[] dateTokens = date.split("\\p{Punct}");
42 |
43 | if (dateTokens.length == 3)
44 | {
45 | //Java months are zero based, so subtract 1
46 | int month = Integer.parseInt(dateTokens[0]) -1;
47 | int day = Integer.parseInt(dateTokens[1]);
48 | int year = Integer.parseInt(dateTokens[2]);
49 |
50 | //in case a 2 digit year was entered
51 | if (year < 100)
52 | year += 2000;
53 |
54 | //get boundary years
55 | GregorianCalendar today = new GregorianCalendar();
56 | //get a lowerLimit that is LOWER_YEAR_LIMIT less then
57 | //today
58 | GregorianCalendar lowerLimit = new GregorianCalendar();
59 | lowerLimit.add(Calendar.YEAR, LOWER_YEAR_LIMIT);
60 |
61 | //create a candidate representing the proposed date.
62 | GregorianCalendar candidate =
63 | new GregorianCalendar(year, month,day);
64 |
65 | //check the validity of the date
66 | if
67 | (
68 | candidate.before(today)
69 | &&
70 | candidate.after(lowerLimit)
71 | &&//month could be off, say the user entered 55
72 | month == candidate.get(Calendar.MONTH)
73 | &&//day could be off, say the user entered 55
74 | day == candidate.get(Calendar.DAY_OF_MONTH)
75 | )
76 | {
77 | retval = true;
78 | }
79 | }
80 | return retval;
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/util/ReplaceString.java:
--------------------------------------------------------------------------------
1 | import java.util.logging.*;
2 | import java.util.regex.*;
3 |
4 | /**
5 | * A utility for replace a subsection of a String with another String
6 | * from a given text which is either passed in or in a file.
7 | * Thus, for "hi Waldo" "hi" "hello",
8 | * hello Waldo is returned.
9 | * Alternately, the input
10 | * "-f" "ReplaceString.java" "ReplaceString" "NewClassName"
11 | * would return the text that makes up this class, but replaces
12 | * all instances of ReplaceString with NewClassName
13 | * @param the String args[]
14 | * @throws Exception
15 | * @author M Habibi
16 | * @version 1.0 2/22/04 6:17 PM
17 | */
18 | public class ReplaceString
19 | {
20 | private static Logger log = Logger.getAnonymousLogger();
21 |
22 | /**
23 | * For "hi Waldo" "hi" "hello",
24 | * hello Waldo is returned.
25 | * Alternately, the input
26 | * "-f" "ReplaceString.java" "ReplaceString" "NewClassName"
27 | * would return the text that makes up this class, but replaces
28 | * all instances of ReplaceString with NewClassName
29 | * @param the String args[]
30 | * @throws Exception
31 | *
32 | * @author M Habibi
33 | */
34 | public static void main(String args[]) throws Exception
35 | {
36 |
37 | if (args != null && args.length == 3)
38 | {
39 | replaceString(args[0],args[1],args[2]);
40 |
41 | }
42 | else if (args != null && args.length == 4 && args[0].equals("-f"))
43 | {
44 | String inputString = RegexUtil.getFileContent(args[1]);
45 | replaceString(inputString,args[2],args[3]);
46 |
47 | }
48 | else
49 | {
50 | String msg = "usage: "hi Waldo" "hi" "hello",
59 | * hello Waldo is returned.
60 | * Alternately, the input
61 | * "-f" "ReplaceString.java" "ReplaceString" "NewClassName"
62 | * would return the text that makes up this class, but replaces
63 | * all instances of ReplaceString with NewClassName
64 | * @param the String text
65 | * @param the String regex
66 | * @param the String replace
67 | * @return String
68 | *
69 | * @author M Habibi
70 | */
71 | private static String replaceString(String text, String regex, String replace)
72 | {
73 | String retval =null;
74 | Pattern p = Pattern.compile(regex);
75 |
76 | Matcher m = p.matcher(text);
77 |
78 | retval = m.replaceAll(replace);
79 | System.out.println("OUT=:"+ retval+":\n");
80 |
81 | return retval;
82 | }
83 |
84 |
85 | }
86 |
--------------------------------------------------------------------------------
/util/StrictRX.java:
--------------------------------------------------------------------------------
1 | import java.util.regex.*;
2 | import java.util.logging.Logger;
3 |
4 | /**
5 | * Applies the given regex pattern to the text in the
6 | * strictest possible way. The text can be optionally
7 | * read in from a file.
8 | *
9 | * @author M Habibi
10 | * @version 1.0 2/22/04 6:57 PM
11 | */
12 | public class StrictRX{
13 | private static Logger log = Logger.getAnonymousLogger();
14 |
15 |
16 | /**
17 | * Reads the users' input.
18 | * usage: java StrictRX String args[]
30 | * @throws Exception
31 | *
32 | * @author M Habibi
33 | */
34 | public static void main(String args[]) throws Exception{
35 | if (args.length == 2){
36 | compare(args[0],args[1]);
37 | }
38 |
39 | else if(args.length == 3 ){
40 |
41 | log.info("args0=:"+ args[0]+":");
42 | log.info("args1=:"+ args[1]+":");
43 | log.info("args2=:"+ args[2]+":");
44 |
45 | String pattern = RegexUtil.getProperty(args[1],args[2]);
46 | compare(args[0],pattern);
47 | }
48 | else if(args.length == 4 && args[0].equals("-f")){
49 |
50 | log.info("args0=:"+ args[0]+":");
51 | log.info("args1=:"+ args[1]+":");
52 | log.info("args2=:"+ args[2]+":");
53 | log.info("args3=:"+ args[3]+":");
54 |
55 | String inputString = RegexUtil.getFileContent(args[1]);
56 |
57 | String pattern = RegexUtil.getProperty(args[2],args[3]);
58 | compare(inputString,pattern);
59 | }
60 | else{
61 | System.out.println("usage: java StrictRX target regex");
62 | System.out.println("usage: java StrictRX target String text
71 | * @param the String regex
72 | *
73 | * @author M Habibi
74 | */
75 | public static void compare(String text, String regex){
76 |
77 | //display the original input string
78 | System.out.println("INPUT:" + text+":");
79 | //display the search pattern
80 | System.out.println("REGEX:" + regex +":\r\n");
81 |
82 | if (text.matches(regex)) System.out.println ("MATCH: " + text);
83 | else System.out.println("NO MATCH");
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/docs/deprecated-list.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
31 |
32 |
|
43 | 44 | 45 | | 46 |||||||||
| 50 | PREV 51 | NEXT | 52 |53 | FRAMES 54 | NO FRAMES 55 | 62 | 65 | 66 | | 67 |||||||||
73 |
75 | Deprecated API
76 |78 | 79 | 80 | 81 | 82 | 83 |
86 |
87 |
|
98 | 99 | 100 | | 101 |||||||||
| 105 | PREV 106 | NEXT | 107 |108 | FRAMES 109 | NO FRAMES 110 | 117 | 120 | 121 | | 122 |||||||||
128 | 129 | 130 | 131 | -------------------------------------------------------------------------------- /docs/allclasses-noframe.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
20 | 21 |
31 |
32 |
|
43 | 44 | 45 | | 46 |||||||||
| 50 | PREV 51 | NEXT | 52 |53 | FRAMES 54 | NO FRAMES 55 | 62 | 65 | 66 | | 67 |||||||||
73 |
75 | Constant Field Values
76 |78 | Contents
-
79 |
82 | 83 | 84 | 85 | 86 | 87 |
90 |
91 |
|
102 | 103 | 104 | | 105 |||||||||
| 109 | PREV 110 | NEXT | 111 |112 | FRAMES 113 | NO FRAMES 114 | 121 | 124 | 125 | | 126 |||||||||
132 | 133 | 134 | 135 | -------------------------------------------------------------------------------- /chapter4/FileChannelExample.java: -------------------------------------------------------------------------------- 1 | import java.io.*; 2 | import java.nio.*; 3 | import java.nio.channels.*; 4 | 5 | /** 6 | * Provides an easy mechinism for extracting the regex contents 7 | * of a file 8 | */ 9 | public class FileChannelExample{ 10 | public static void main(String args[]) throws IOException{ 11 | 12 | String targetFile = "FileChannelExample.java"; 13 | 14 | //if the user passed in a file to read, then use 15 | //that file instead 16 | if (args != null && args.length ==1) 17 | targetFile = args[0]; 18 | 19 | //getDataUsingFileChannel(targetFile); 20 | //getDataUsingInputStream(targetFile); 21 | getDataUsingMappedFileChannel(targetFile); 22 | 23 | } 24 | 25 | /** 26 | * Extracts data from a file by using FileChannels 27 | * @param targetFile the name and path of the file to read 28 | * @throws IOException if anything goes wrong 29 | */ 30 | public static void getDataUsingFileChannel(String targetFile) 31 | throws IOException{ 32 | //open a connection to the source code for this 33 | //class 34 | 35 | 36 | //measure how long this process takes, 37 | //so take the start time 38 | long startTime = System.currentTimeMillis(); 39 | 40 | FileInputStream fis = 41 | new FileInputStream(targetFile); 42 | 43 | //get a file channel 44 | FileChannel fc = fis.getChannel(); 45 | 46 | //create a ByteBuffer that is large enough 47 | //and read the contents of the file into it 48 | ByteBuffer bb = ByteBuffer.allocate((int)fc.size()); 49 | 50 | fc.read(bb); 51 | 52 | //set the ByteBuffer's position it it's begining 53 | bb.flip(); 54 | 55 | //save the content of the file as a String 56 | String fileContent= new String(bb.array()); 57 | 58 | //so take the end time 59 | long endTime = System.currentTimeMillis(); 60 | 61 | long totalTime = (endTime - startTime); 62 | 63 | //release the FileChannel 64 | fc.close(); 65 | fc = null; 66 | bb = null; 67 | 68 | //write out the contents of this file 69 | System.out.println("--getDataUsingFileChannel "); 70 | 71 | System.out.println("targetFile = " + targetFile); 72 | 73 | System.out.println("totalTime = " + totalTime); 74 | } 75 | 76 | /** 77 | * Extracts data from a file by using FileChannels 78 | * @param targetFile the name and path of the file to read 79 | * @throws IOException if anything goes wrong 80 | */ 81 | public static void getDataUsingMappedFileChannel(String targetFile) 82 | throws IOException{ 83 | //open a connection to the source code for this 84 | //class 85 | 86 | 87 | //measure how long this process takes, 88 | //so take the start time 89 | long startTime = System.currentTimeMillis(); 90 | 91 | FileInputStream fis = 92 | new FileInputStream(targetFile); 93 | 94 | //get a file channel 95 | FileChannel fc = fis.getChannel(); 96 | 97 | //map the byte buffer directly into memory 98 | fc.map(FileChannel.MapMode.READ_ONLY,0,(int)fc.size()); 99 | 100 | //create a ByteBuffer that is large enough 101 | //and read the contents of the file into it 102 | ByteBuffer bb = ByteBuffer.allocate((int)fc.size()); 103 | 104 | fc.read(bb); 105 | 106 | //set the ByteBuffer's position it it's begining 107 | bb.flip(); 108 | 109 | //save the content of the file as a String 110 | String fileContent= new String(bb.array()); 111 | 112 | //so take the end time 113 | long endTime = System.currentTimeMillis(); 114 | 115 | long totalTime = (endTime - startTime); 116 | 117 | //release the FileChannel 118 | fc.close(); 119 | fc = null; 120 | 121 | //write out the contents of this file 122 | System.out.println("--getDataUsingMappedFileChannel "); 123 | 124 | System.out.println("targetFile = " + targetFile); 125 | 126 | System.out.println("totalTime = " + totalTime); 127 | } 128 | 129 | /** 130 | * Extracts data from a file by using an InputStream 131 | * @param targetFile the name and path of the file to read 132 | * @throws IOException if anything goes wrong 133 | */ 134 | public static void getDataUsingInputStream(String targetFile) 135 | throws IOException{ 136 | //open a connection to the source code for this 137 | //class 138 | 139 | //measure how long this process takes, 140 | //so take the start time 141 | long startTime = System.currentTimeMillis(); 142 | 143 | File file = new File(targetFile); 144 | 145 | //get the size of the file 146 | int fileSize = (int)file.length(); 147 | 148 | FileInputStream fis = 149 | new FileInputStream(file); 150 | 151 | //create a byte[] that is large enough 152 | //and read the contents of the file into it 153 | byte[] byteArray = new byte[fileSize]; 154 | 155 | fis.read(byteArray); 156 | 157 | 158 | //save the content of the file as a String 159 | String fileContent= new String(byteArray); 160 | 161 | //so take the end time 162 | long endTime = System.currentTimeMillis(); 163 | 164 | long totalTime = (endTime - startTime); 165 | 166 | //release the file and stream 167 | fis.close(); 168 | fis = null; 169 | file = null; 170 | 171 | //write out the contents of this file 172 | System.out.println("--getDataUsingInputStream"); 173 | 174 | System.out.println("targetFile = " + targetFile); 175 | System.out.println("totalTime = " + totalTime); 176 | } 177 | } 178 | -------------------------------------------------------------------------------- /docs/allclasses-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
20 | 21 |
Property file convention for \n,\t, etc.,
19 | * or multiline properties. Please see the documentation for the
20 | * load method.
21 | */
22 | public class RegexProperties extends Properties{
23 | private static Logger log = Logger.getAnonymousLogger();
24 | private String fileContent=null;
25 |
26 | /**
27 | * loads the file. @See load(FileInputStream inStream)
28 | *
29 | * @param String the name of the file to load
30 | * @throws IOException if there's an IO problem
31 | * @throws PatternSyntaxException if the File format isn't properly
32 | * formed, per the specification given above.
33 | */
34 |
35 | public void load(String inStream)
36 | throws IOException, PatternSyntaxException{
37 | load(new FileInputStream(inStream));
38 | }
39 | /**
40 | * Specialized property file for reading regular expressions
41 | * stored as properties. Reads a property list (key and
42 | * element pairs) from the input stream using a FileChannel,
43 | * thus allowing the usage of all characters. The stream is
44 | * assumed to be using the ISO 8859-1 character encoding.
45 | * Every property occupies one line of the input stream. Each
46 | * line is terminated by a line terminator (\n or \r or \r\n).
47 | * The entire contents of the file are read in.
48 | *
49 | A line that contains only whitespace or whose first
50 | * non-whitespace character is an ASCII # or ! is ignored
51 | * (thus, # or ! indicate comment lines).
52 | *
53 | * Every line other than a blank line or a comment line describes
54 | * one property to be added to the table. The key consists of
55 | * all the characters in the line starting with the first
56 | * non-whitespace character and up to, but not including,
57 | * the first ASCII =, :, or whitespace character. Any whitespace
58 | * after the key is skipped; if the first non-whitespace character
59 | * after the key is = or :, then it is ignored. White space character
60 | * after the = or ; are not skipped, and become part of the
61 | * value. This is a deliberate change from the default behavior of
62 | * the class, in order to support regular expressions, which may very
63 | * well need those characters. All remaining characters on the line
64 | * become part of the associated element string. If the last
65 | * character on the line is \, then the next line is not
66 | * treated as a continuation of the current line. Again, this is a
67 | * deliberate change from the default behavior of the class, in
68 | * order to support regular expressions.
69 | *
70 | * @param FileInputStream inStream the actual property file
71 | * @throws IOException if there's an IO problem
72 | * @throws PatternSyntaxException if the File format isn't properly
73 | * formed, per the specification given above.
74 | */
75 |
76 | public void load(FileInputStream inStream) throws IOException, PatternSyntaxException{
77 | // load the contents of the file
78 | FileChannel fc = inStream.getChannel();
79 |
80 | ByteBuffer bb = ByteBuffer.allocate((int)fc.size());
81 | fc.read(bb);
82 | bb.flip();
83 | fileContent = new String(bb.array());
84 |
85 | //define a pattern that breaks the contents down line by line
86 | Pattern pattern = Pattern.compile("^(.*)$",Pattern.MULTILINE);
87 | Matcher matcher = pattern.matcher(fileContent);
88 |
89 | //iterate through the fileContent, line by line
90 | while (matcher.find()){
91 | //extract the relevant part of each file.
92 | //in this case, relevant means the characters
93 | //between the beginning of the line and it's end
94 | String line = matcher.group(1) ;
95 |
96 | //if the line is null or a comment, ignore it
97 | if (
98 | line != null &&
99 | !"".equals(line.trim()) &&
100 | !line.startsWith("#") &&
101 | !line.startsWith("!")
102 | )
103 | {
104 | String keyValue[] = null;
105 |
106 | //was the kay-value entry split with the '='
107 | //character or the ':' character? Both are legal.
108 | if (line.indexOf("=") > 0 )
109 | keyValue = line.split("=",2);
110 | else
111 | keyValue = line.split(":",2);
112 |
113 | //final check that keyValue isn't null, because we
114 | //are going to be entering into a map, and trimming it
115 | if (keyValue != null)
116 | {
117 | super.put(keyValue[0].trim(),keyValue[1]);
118 | }
119 | }
120 | }
121 |
122 | fc = null;
123 | bb = null;
124 | }
125 | /**
126 | * Not supported. This is designed to be read only class
127 | * Throws UnsupportedOperationException.
128 | * @param String the key to be placed into this property
129 | * list.
130 | * @param String the value corresponding to key.
131 | * @throws UnsupportedOperationException
132 | *
133 | */
134 | public void store(FileOutputStream out, String header)
135 | throws UnsupportedOperationException
136 | {
137 | String msg = "unsupported for this class";
138 | throw new UnsupportedOperationException(msg);
139 | }
140 | /**
141 | * Not supported.
142 | * @param Object t - Mappings to be stored in this map.
143 | *
144 | * @returns nothing, since this call always throws an
145 | * UnsupportedOperationException.
146 | * @throws UnsupportedOperationException
147 | */
148 | public void putAll(Map t)
149 | {
150 | String msg = "unsupported for this class";
151 | throw new UnsupportedOperationException(msg);
152 | }
153 |
154 | }
155 |
--------------------------------------------------------------------------------
/docs/serialized-form.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
31 |
32 |
|
43 | 44 | 45 | | 46 |||||||||
| 50 | PREV 51 | NEXT | 52 |53 | FRAMES 54 | NO FRAMES 55 | 62 | 65 | 66 | | 67 |||||||||
73 |
75 | Serialized Form
76 || 81 | Class Regex extends java.lang.Object implements Serializable | 82 |
| 90 | Serialized Fields | 91 |
95 | regex
96 |97 | java.lang.String regex98 |
-
99 |
-
100 |
103 | 104 |
105 | description
106 |107 | java.lang.String description108 |
-
109 |
-
110 |
114 |
115 | 116 |
| 119 | Class RegexProperties extends java.util.Properties implements Serializable | 120 |
| 128 | Serialized Fields | 129 |
133 | fileContent
134 |135 | java.lang.String fileContent136 |
-
137 |
-
138 |
142 |
143 | 144 | 145 | 146 | 147 | 148 |
151 |
152 |
|
163 | 164 | 165 | | 166 |||||||||
| 170 | PREV 171 | NEXT | 172 |173 | FRAMES 174 | NO FRAMES 175 | 182 | 185 | 186 | | 187 |||||||||
193 | 194 | 195 | 196 | -------------------------------------------------------------------------------- /docs/help-doc.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
31 |
32 |
|
43 | 44 | 45 | | 46 |||||||||
| 50 | PREV 51 | NEXT | 52 |53 | FRAMES 54 | NO FRAMES 55 | 62 | 65 | 66 | | 67 |||||||||
73 |
75 | How This API Document Is Organized
76 |78 | Package
79 |80 | 81 |85 |82 | Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
83 |
84 |- Interfaces (italic)
- Classes
- Exceptions
- Errors
86 | Class/Interface
87 |88 | 89 |97 |90 | Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
91 |
96 | Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description 92 |
93 |
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary 94 |
95 |
- Field Detail
- Constructor Detail
- Method Detail
98 | Tree (Class Hierarchy)
99 |100 | There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with103 |java.lang.Object. The interfaces do not inherit fromjava.lang.Object.101 |
102 |- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
104 | Deprecated API
105 |106 | The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.107 |
108 | Index
109 |110 | The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.111 |
112 | Prev/Next
113 | These links take you to the next or previous class, interface, package, or related page.114 | Frames/No Frames
115 | These links show and hide the HTML frames. All pages are available with or without frames. 116 |117 |
118 | Serialized Form
119 | Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. 120 |
121 |
122 |
123 | This help file applies to API documentation generated using the standard doclet.
124 |
125 |
126 |
127 | 128 | 129 | 130 | 131 | 132 |
135 |
136 |
|
147 | 148 | 149 | | 150 |||||||||
| 154 | PREV 155 | NEXT | 156 |157 | FRAMES 158 | NO FRAMES 159 | 166 | 169 | 170 | | 171 |||||||||
177 | 178 | 179 | 180 | -------------------------------------------------------------------------------- /docs/Split.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class Split
84 |85 | java.lang.Object 86 |88 |Split 87 |
89 |
-
90 |
- public class Split
- extends java.lang.Object
93 | Demonstrates very simple String manipulation using 94 | English synonyms. 95 |
96 | 97 |
98 |
99 | 100 |
101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 |
| 113 | Constructor Summary | 114 ||
Split()
117 |
118 | 119 | |
120 | |
| 129 | Method Summary | 130 ||
133 | static void |
134 | main(java.lang.String[] args)
135 |
136 | 137 | |
138 |
| Methods inherited from class java.lang.Object | 144 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
147 |
151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 |
| 161 | Constructor Detail | 162 |
166 | Split
167 |168 | public Split()169 |
-
170 |
| 178 | Method Detail | 179 |
183 | main
184 |185 | public static void main(java.lang.String[] args)186 |
-
187 |
-
188 |
190 |
193 | 194 | 195 | 196 | 197 | 198 |
201 |
202 |
|
214 | 215 | 216 | | 217 ||||||||||
| 221 | PREV CLASS 222 | NEXT CLASS | 223 |224 | FRAMES 225 | NO FRAMES 226 | 233 | 236 | 237 | | 238 ||||||||||
| 241 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 242 |243 | DETAIL: FIELD | CONSTR | METHOD | 244 ||||||||||
250 | 251 | 252 | 253 | -------------------------------------------------------------------------------- /docs/GreedyExample.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class GreedyExample
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class GreedyExample
- extends java.lang.Object
93 | Demonstrates usage of a greedy qualifier 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
GreedyExample()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | GreedyExample
166 |167 | public GreedyExample()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args)185 |
-
186 |
-
187 |
189 |
192 | 193 | 194 | 195 | 196 | 197 |
200 |
201 |
|
213 | 214 | 215 | | 216 ||||||||||
| 220 | PREV CLASS 221 | NEXT CLASS | 222 |223 | FRAMES 224 | NO FRAMES 225 | 232 | 235 | 236 | | 237 ||||||||||
| 240 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 241 |242 | DETAIL: FIELD | CONSTR | METHOD | 243 ||||||||||
249 | 250 | 251 | 252 | -------------------------------------------------------------------------------- /docs/FindA.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class FindA
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class FindA
- extends java.lang.Object
93 | Demonstrates finding all words that start with an 'a' 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
FindA()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | FindA
166 |167 | public FindA()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args) 185 | throws java.lang.Exception186 |
-
187 |
-
188 |
189 |
- Throws: 190 |
java.lang.Exception
192 |
195 | 196 | 197 | 198 | 199 | 200 |
203 |
204 |
|
216 | 217 | 218 | | 219 ||||||||||
| 223 | PREV CLASS 224 | NEXT CLASS | 225 |226 | FRAMES 227 | NO FRAMES 228 | 235 | 238 | 239 | | 240 ||||||||||
| 243 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 244 |245 | DETAIL: FIELD | CONSTR | METHOD | 246 ||||||||||
252 | 253 | 254 | 255 | -------------------------------------------------------------------------------- /docs/ReplaceExample.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class ReplaceExample
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class ReplaceExample
- extends java.lang.Object
93 | Demonstrates replacing text using regex 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
ReplaceExample()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | ReplaceExample
166 |167 | public ReplaceExample()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args)185 |
-
186 |
-
187 |
189 |
192 | 193 | 194 | 195 | 196 | 197 |
200 |
201 |
|
213 | 214 | 215 | | 216 ||||||||||
| 220 | PREV CLASS 221 | NEXT CLASS | 222 |223 | FRAMES 224 | NO FRAMES 225 | 232 | 235 | 236 | | 237 ||||||||||
| 240 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 241 |242 | DETAIL: FIELD | CONSTR | METHOD | 243 ||||||||||
249 | 250 | 251 | 252 | -------------------------------------------------------------------------------- /docs/PatternSplit.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class PatternSplit
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class PatternSplit
- extends java.lang.Object
93 | Demonstrates usage of the Pattern split method 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
PatternSplit()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | PatternSplit
166 |167 | public PatternSplit()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args)185 |
-
186 |
-
187 |
189 |
192 | 193 | 194 | 195 | 196 | 197 |
200 |
201 |
|
213 | 214 | 215 | | 216 ||||||||||
| 220 | PREV CLASS 221 | NEXT CLASS | 222 |223 | FRAMES 224 | NO FRAMES 225 | 232 | 235 | 236 | | 237 ||||||||||
| 240 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 241 |242 | DETAIL: FIELD | CONSTR | METHOD | 243 ||||||||||
249 | 250 | 251 | 252 | -------------------------------------------------------------------------------- /docs/ReluctantExample.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class ReluctantExample
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class ReluctantExample
- extends java.lang.Object
93 | Demonstrates usage of a Reluctant qualifier 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
ReluctantExample()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | ReluctantExample
166 |167 | public ReluctantExample()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args)185 |
-
186 |
-
187 |
189 |
192 | 193 | 194 | 195 | 196 | 197 |
200 |
201 |
|
213 | 214 | 215 | | 216 ||||||||||
| 220 | PREV CLASS 221 | NEXT CLASS | 222 |223 | FRAMES 224 | NO FRAMES 225 | 232 | 235 | 236 | | 237 ||||||||||
| 240 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 241 |242 | DETAIL: FIELD | CONSTR | METHOD | 243 ||||||||||
249 | 250 | 251 | 252 | -------------------------------------------------------------------------------- /docs/PossesiveExample.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
32 |
33 |
|
45 | 46 | 47 | | 48 ||||||||||
| 52 | PREV CLASS 53 | NEXT CLASS | 54 |55 | FRAMES 56 | NO FRAMES 57 | 64 | 67 | 68 | | 69 ||||||||||
| 72 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 73 |74 | DETAIL: FIELD | CONSTR | METHOD | 75 ||||||||||
81 | 82 |
83 | Class PossesiveExample
84 |85 | java.lang.Object 86 |88 |
89 |
-
90 |
- public class PossesiveExample
- extends java.lang.Object
93 | Demonstrates usage of a possessive qualifier 94 |
95 | 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 |
| 112 | Constructor Summary | 113 ||
PossesiveExample()
116 |
117 | 118 | |
119 | |
| 128 | Method Summary | 129 ||
132 | static void |
133 | main(java.lang.String[] args)
134 |
135 | 136 | |
137 |
| Methods inherited from class java.lang.Object | 143 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
146 |
150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
| 160 | Constructor Detail | 161 |
165 | PossesiveExample
166 |167 | public PossesiveExample()168 |
-
169 |
| 177 | Method Detail | 178 |
182 | main
183 |184 | public static void main(java.lang.String[] args)185 |
-
186 |
-
187 |
189 |
192 | 193 | 194 | 195 | 196 | 197 |
200 |
201 |
|
213 | 214 | 215 | | 216 ||||||||||
| 220 | PREV CLASS 221 | NEXT CLASS | 222 |223 | FRAMES 224 | NO FRAMES 225 | 232 | 235 | 236 | | 237 ||||||||||
| 240 | SUMMARY: NESTED | FIELD | CONSTR | METHOD | 241 |242 | DETAIL: FIELD | CONSTR | METHOD | 243 ||||||||||
249 | 250 | 251 | 252 | --------------------------------------------------------------------------------