src/java.base/share/classes/java/util/regex/package-info.java
author jboes
Tue, 24 Sep 2019 09:43:43 +0100
changeset 58288 48e480e56aad
parent 47216 71c04702a3d5
permissions -rw-r--r--
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base Summary: Minor coding style update of javadoc tag in any file in java.base Reviewed-by: bchristi, lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     1
/*
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 47216
diff changeset
     2
 * Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     4
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    10
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    15
 * accompanied this code).
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    16
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    20
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    23
 * questions.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    24
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    26
/**
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    27
 * Classes for matching character sequences against patterns specified
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    28
 * by regular expressions.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    29
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    30
 * <p> An instance of the {@link java.util.regex.Pattern} class
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    31
 * represents a regular expression that is specified in string form in
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    32
 * a syntax similar to that used by Perl.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    33
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    34
 * <p> Instances of the {@link java.util.regex.Matcher} class are used
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    35
 * to match character sequences against a given pattern.  Input is
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    36
 * provided to matchers via the {@link java.lang.CharSequence}
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    37
 * interface in order to support matching against characters from a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    38
 * wide variety of input sources. </p>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    39
 *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 47216
diff changeset
    40
 * <p> Unless otherwise noted, passing a {@code null} argument to a
30788
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    41
 * method in any class or interface in this package will cause a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    42
 * {@link java.lang.NullPointerException NullPointerException} to be
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    43
 * thrown.
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    44
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    45
 * <h2>Related Documentation</h2>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    46
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    47
 * <p> An excellent tutorial and overview of regular expressions is <a
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    48
 * href="http://www.oreilly.com/catalog/regex/"><i>Mastering Regular
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    49
 * Expressions</i>, Jeffrey E. F. Friedl, O'Reilly and Associates,
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    50
 * 1997.</a> </p>
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    51
 *
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    52
 * @since 1.4
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    53
 * @author Mike McCloskey
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    54
 * @author Mark Reinhold
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    55
 */
ea573d35531a 8080901: Replace package.html files with package-info.java in the java.base module
darcy
parents: 25859
diff changeset
    56
package java.util.regex;