001 /*
002 * Copyright 1999-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.util.regex;
027
028 import sun.security.action.GetPropertyAction;
029
030 /**
031 * Unchecked exception thrown to indicate a syntax error in a
032 * regular-expression pattern.
033 *
034 * @author unascribed
035 * @version 1.22, 07/05/05
036 * @since 1.4
037 * @spec JSR-51
038 */
039
040 public class PatternSyntaxException extends IllegalArgumentException {
041
042 private final String desc;
043 private final String pattern;
044 private final int index;
045
046 /**
047 * Constructs a new instance of this class.
048 *
049 * @param desc
050 * A description of the error
051 *
052 * @param regex
053 * The erroneous pattern
054 *
055 * @param index
056 * The approximate index in the pattern of the error,
057 * or <tt>-1</tt> if the index is not known
058 */
059 public PatternSyntaxException(String desc, String regex, int index) {
060 this .desc = desc;
061 this .pattern = regex;
062 this .index = index;
063 }
064
065 /**
066 * Retrieves the error index.
067 *
068 * @return The approximate index in the pattern of the error,
069 * or <tt>-1</tt> if the index is not known
070 */
071 public int getIndex() {
072 return index;
073 }
074
075 /**
076 * Retrieves the description of the error.
077 *
078 * @return The description of the error
079 */
080 public String getDescription() {
081 return desc;
082 }
083
084 /**
085 * Retrieves the erroneous regular-expression pattern.
086 *
087 * @return The erroneous pattern
088 */
089 public String getPattern() {
090 return pattern;
091 }
092
093 private static final String nl = java.security.AccessController
094 .doPrivileged(new GetPropertyAction("line.separator"));
095
096 /**
097 * Returns a multi-line string containing the description of the syntax
098 * error and its index, the erroneous regular-expression pattern, and a
099 * visual indication of the error index within the pattern.
100 *
101 * @return The full detail message
102 */
103 public String getMessage() {
104 StringBuffer sb = new StringBuffer();
105 sb.append(desc);
106 if (index >= 0) {
107 sb.append(" near index ");
108 sb.append(index);
109 }
110 sb.append(nl);
111 sb.append(pattern);
112 if (index >= 0) {
113 sb.append(nl);
114 for (int i = 0; i < index; i++)
115 sb.append(' ');
116 sb.append('^');
117 }
118 return sb.toString();
119 }
120
121 }
|