Source for java.util.regex.PatternSyntaxException

   1: /* PatternSyntaxException - Indicates illegal pattern for regular expression.
   2:    Copyright (C) 2002 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.util.regex;
  39: 
  40: import gnu.java.lang.CPStringBuilder;
  41: 
  42: /**
  43:  * Indicates illegal pattern for regular expression.
  44:  * Includes state to inspect the pattern and what and where the expression
  45:  * was not valid regular expression.
  46:  * @since 1.4
  47:  */
  48: public class PatternSyntaxException extends IllegalArgumentException
  49: {
  50:   private static final long serialVersionUID = -3864639126226059218L;
  51: 
  52:   /**
  53:    * Human readable escription of the syntax error.
  54:    */
  55:   private final String desc;
  56: 
  57:   /**
  58:    * The original pattern that contained the syntax error.
  59:    */
  60:   private final String pattern;
  61: 
  62:   /**
  63:    * Index of the first character in the String that was probably invalid,
  64:    * or -1 when unknown.
  65:    */
  66:   private final int index;
  67: 
  68:   /**
  69:    * Creates a new PatternSyntaxException.
  70:    *
  71:    * @param description Human readable escription of the syntax error.
  72:    * @param pattern The original pattern that contained the syntax error.
  73:    * @param index Index of the first character in the String that was
  74:    *        probably invalid, or -1 when unknown.
  75:    */
  76:   public PatternSyntaxException(String description,
  77:                                 String pattern,
  78:                                 int index)
  79:   {
  80:     super(description);
  81:     this.desc = description;
  82:     this.pattern = pattern;
  83:     this.index = index;
  84:   }
  85: 
  86:   /**
  87:    * Returns a human readable escription of the syntax error.
  88:    */
  89:   public String getDescription()
  90:   {
  91:     return desc;
  92:   }
  93: 
  94:   /**
  95:    * Returns the original pattern that contained the syntax error.
  96:    */
  97:   public String getPattern()
  98:   {
  99:     return pattern;
 100:   }
 101: 
 102:   /**
 103:    * Returns the index of the first character in the String that was probably
 104:    * invalid, or -1 when unknown.
 105:    */
 106:   public int getIndex()
 107:   {
 108:     return index;
 109:   }
 110: 
 111:   /**
 112:    * Returns a string containing a line with the description, a line with
 113:    * the original pattern and a line indicating with a ^ which character is
 114:    * probably the first invalid character in the pattern if the index is not
 115:    * negative.
 116:    */
 117:   public String getMessage()
 118:   {
 119:     String lineSep = System.getProperty("line.separator");
 120:     CPStringBuilder sb = new CPStringBuilder(desc);
 121:     sb.append(lineSep);
 122:     sb.append('\t');
 123:     sb.append(pattern);
 124:     if (index != -1)
 125:       {
 126:         sb.append(lineSep);
 127:         sb.append('\t');
 128:         for (int i=0; i<index; i++)
 129:           sb.append(' ');
 130:         sb.append('^');
 131:       }
 132:     return sb.toString();
 133:   }
 134: 
 135: }