View Javadoc
1   /*
2    * $Header: /cvsroot/sinon/sinon/src/java/eteg/sinon/exception/FromToDataExtractionException.java,v 1.2 2005/06/21 14:25:08 thiagohp Exp $
3    * $Revision: 1.2 $
4    * $Date: 2005/06/21 14:25:08 $
5    * $Author: thiagohp $
6    *
7    * =============================================================================
8    *
9    * Copyright 2004-2005 Eteg Internet Ltda. (http://www.eteg.com.br)
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License");
12   * you may not use this file except in compliance with the License.
13   * You may obtain a copy of the License at
14   *
15   *     http://www.apache.org/licenses/LICENSE-2.0
16   *
17   * Unless required by applicable law or agreed to in writing, software
18   * distributed under the License is distributed on an "AS IS" BASIS,
19   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   * See the License for the specific language governing permissions and
21   * limitations under the License.
22   */
23  package eteg.sinon.exception;
24  
25  import eteg.sinon.executor.CollectorExecutor;
26  
27  /***
28   * Exceção levantada quando uma extração de dados baseada em <i>tags</i>
29   * <code>from</code> e <code>to</code> não é feita com sucesso. Caso ambas
30   * sejam encontradas, a exceção diz que a posição de fim é anterior à
31   * posição de início.
32   *
33   * @author <a href="mailto:thiagohp at users.sourceforge.net">Thiago H. de Paula Figueiredo</a>
34   * @author Last modified by $Author: thiagohp $
35   * @version $Revision: 1.2 $
36   * @since 0.0
37   */
38  public class FromToDataExtractionException extends StepException {
39  
40      /***
41       * A referência de início do dado a ser extraído foi encontrada?
42       */
43      private boolean fromReferenceFound;
44  
45      /***
46       * A referência de fim do dado a ser extraído foi encontrada?
47       */
48      private boolean toReferenceFound;
49  
50      /***
51       * Construtor que recebe uma mensagem, o executor sendo executado,
52       * a informação de que referência de início do dado a ser extraído foi
53       * encontrada e a informação de que referência de início do dado a ser
54       * extraído foi encontrada.
55       *
56       * @param message uma <code>String</code>.
57       * @param executor um {@link CollectorExecutor}.
58       * @param fromReferenceFound um <code>boolean</code>.
59       * @param toReferenceFound um <code>boolean</code>.
60       * @see #isFromReferenceFound
61       * @see #isToReferenceFound
62       */
63      public FromToDataExtractionException(String message,
64                                           CollectorExecutor executor,
65                                           boolean fromReferenceFound,
66                                           boolean toReferenceFound) {
67  
68          super(message, executor);
69          this.fromReferenceFound = fromReferenceFound;
70          this.toReferenceFound = toReferenceFound;
71  
72      }
73  
74      /***
75       * Diz se a referência de início do dado a ser extraído foi encontrada.
76       *
77       * @return <code>true</code> se a referência de início do dado a ser
78       * extraído foi encontrada, <code>false</code> caso contrário.
79       */
80      public boolean isFromReferenceFound() {
81          return fromReferenceFound;
82      }
83  
84      /***
85       * Diz se a referência de fim do dado a ser extraído foi encontrada.
86       *
87       * @return <code>true</code> se a referência de fim do dado a ser
88       * extraído foi encontrada, <code>false</code> caso contrário.
89       */
90      public boolean isToReferenceFound() {
91          return toReferenceFound;
92      }
93  
94  }