View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.dialog.base;
19  
20  import org.apache.shale.dialog.DialogContext;
21  import org.apache.shale.dialog.DialogContextListener;
22  
23  /***
24   * <p>Convenience abstract {@link DialogContextListener} implementation. Subclasses
25   * are expected to be serializable.</p>
26   *
27   * @since 1.0.4
28   */
29  public abstract class AbstractDialogContextListener implements DialogContextListener {
30  
31      //------------------------------------------------------------- Properties
32  
33      /***
34       * The {@link DialogContext} we are interested in.
35       */
36      private DialogContext dialogContext;
37  
38  
39      //------------------------------------------------- DialogContextListener methods
40  
41      /***
42       * {@inheritDoc}
43       *
44       * @see org.apache.shale.dialog.DialogContextListener#onStart()
45       */
46      public void onStart() {
47  
48          // Do nothing
49  
50      }
51  
52      /***
53       * {@inheritDoc}
54       *
55       * @see org.apache.shale.dialog.DialogContextListener#onStop()
56       */
57      public void onStop() {
58  
59          // Do nothing
60  
61      }
62  
63      /***
64       * {@inheritDoc}
65       *
66       * @see org.apache.shale.dialog.DialogContextListener#onException(java.lang.Exception)
67       */
68      public void onException(Exception e) {
69  
70          // Do nothing
71  
72      }
73  
74      /***
75       * {@inheritDoc}
76       *
77       * @see org.apache.shale.dialog.DialogContextListener#onEntry(java.lang.String)
78       */
79      public void onEntry(String stateId) {
80  
81          // Do nothing
82  
83      }
84  
85      /***
86       * {@inheritDoc}
87       *
88       * @see org.apache.shale.dialog.DialogContextListener#onExit(java.lang.String)
89       */
90      public void onExit(String stateId) {
91  
92          // Do nothing
93  
94      }
95  
96      /***
97       * {@inheritDoc}
98       *
99       * @see org.apache.shale.dialog.DialogContextListener#onTransition(java.lang.String,java.lang.String)
100      */
101     public void onTransition(String fromStateId, String toStateId) {
102 
103         // Do nothing
104 
105     }
106 
107     /***
108      * {@inheritDoc}
109      *
110      * @see org.apache.shale.dialog.DialogContextListener#getDialogContext()
111      */
112     public DialogContext getDialogContext() {
113 
114         return dialogContext;
115 
116     }
117 
118     /***
119      * {@inheritDoc}
120      *
121      * @see org.apache.shale.dialog.DialogContextListener#setDialogContext(org.apache.shale.dialog.DialogContext)
122      */
123     public void setDialogContext(DialogContext dialogContext) {
124 
125         this.dialogContext = dialogContext;
126 
127     }
128 
129 }