View Javadoc
1   package net.sourceforge.jenesis4java;
2   
3   /*
4    * #%L
5    * Jenesis 4 Java Code Generator
6    * %%
7    * Copyright (C) 2000 - 2015 jenesis4java
8    * %%
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   * 
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   * 
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * #L%
23   */
24  
25  /**
26   * Copyright (C) 2008, 2010 Richard van Nieuwenhoven - ritchie [at] gmx [dot] at
27   * Copyright (C) 2000, 2001 Paul Cody Johnston - pcj@inxar.org <br>
28   * This file is part of Jenesis4java. Jenesis4java is free software: you can
29   * redistribute it and/or modify it under the terms of the GNU Lesser General
30   * Public License as published by the Free Software Foundation, either version 3
31   * of the License, or (at your option) any later version.<br>
32   * Jenesis4java is distributed in the hope that it will be useful, but WITHOUT
33   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
34   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
35   * details.<br>
36   * You should have received a copy of the GNU Lesser General Public License
37   * along with Jenesis4java. If not, see <http://www.gnu.org/licenses/>.
38   */
39  
40  import java.util.List;
41  
42  /**
43   * {@code Statement} subinterface for the {@code catch} construct in a
44   * {@code try}.
45   */
46  public interface Catch extends Block {
47  
48      /**
49       * Gets the formal parameter for this catch clause. if more than one formal
50       * parameter has been declared, only the first one is returned.
51       */
52      FormalParameter getThrowable();
53  
54      /**
55       * Sets the formal parameter for this catch clause.<br>
56       * Overwrites the current formal parameter(s).
57       */
58      Catch setThrowable(Type type, String name);
59  
60      /**
61       * Returns an immutable list containing the formal parameters of this catch
62       * clause.
63       * 
64       * @return an immutable list containing the formal parameters for this catch
65       *         clause.
66       */
67      List<FormalParameter> getThrowables();
68  
69      /**
70       * Adds a formal parameter to this catch clause.
71       * 
72       * @return this catch clause instance.
73       */
74      Catch addThrowable(Type type, String name);
75  }