Copyright test
[jalview.git] / src / com / stevesoft / pat / BackRefRule.java
1 /*******************************************************************************
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $(date) The Jalview Authors
4  *
5  * This file is part of Jalview.
6  *  
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *   
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  *******************************************************************************/
21 //
22 // This software is now distributed according to
23 // the Lesser Gnu Public License.  Please see
24 // http://www.gnu.org/copyleft/lesser.txt for
25 // the details.
26 //    -- Happy Computing!
27 //
28 package com.stevesoft.pat;
29
30 /**
31  * This method implements the pattern elements $1, $2, etc in a substitution
32  * rule. The apply(StringBufferLike sb,RegRes rr) method of this ReplaceRule
33  * simply appends the contents of rr.stringMatched(n), where n is the integer
34  * supplied to the constructor.
35  */
36 public class BackRefRule extends ReplaceRule
37 {
38   int n;
39
40   public BackRefRule(int n)
41   {
42     this.n = n;
43   }
44
45   public void apply(StringBufferLike sb, RegRes res)
46   {
47     String x = res.stringMatched(n);
48     sb.append(x == null ? "" : x);
49   }
50
51   public String toString1()
52   {
53     return "$" + n;
54   }
55
56   public Object clone1()
57   {
58     return new BackRefRule(n);
59   }
60 }