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  package org.apache.jetspeed.om.folder.impl;
18  
19  import org.apache.jetspeed.om.folder.MenuOptionsDefinition;
20  
21  /***
22   * This abstract class implements the menu options definition
23   * interface in a default manner to allow derived classes to
24   * easily describe standard menu definitions.
25   * 
26   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
27   * @version $Id: StandardMenuOptionsDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $
28   */
29  public abstract class StandardMenuOptionsDefinitionImpl implements MenuOptionsDefinition
30  {
31      /***
32       * StandardMenuOptionsDefinitionImpl - constructor
33       */
34      public StandardMenuOptionsDefinitionImpl()
35      {
36      }
37  
38      /***
39       * getOptions - get comma separated menu options
40       *
41       * @return option paths specification
42       */
43      public String getOptions()
44      {
45          return null;
46      }
47  
48      /***
49       * setOptions - set comma separated menu options
50       *
51       * @param options option paths specification
52       */
53      public void setOptions(String options)
54      {
55          throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
56      }
57  
58      /***
59       * getDepth - get depth of inclusion for folder options
60       *
61       * @return inclusion depth
62       */
63      public int getDepth()
64      {
65          return 0;
66      }
67  
68      /***
69       * setDepth - set depth of inclusion for folder options
70       *
71       * @param depth inclusion depth
72       */
73      public void setDepth(int depth)
74      {
75          throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
76      }
77  
78      /***
79       * isPaths - get generate ordered path options
80       *
81       * @return paths options flag
82       */
83      public boolean isPaths()
84      {
85          return false;
86      }
87      
88      /***
89       * setPaths - set generate ordered path options
90       *
91       * @param paths paths options flag
92       */
93      public void setPaths(boolean paths)
94      {
95          throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
96      }
97      
98      /***
99       * isRegexp - get regexp flag for interpreting options
100      *
101      * @return regexp flag
102      */
103     public boolean isRegexp()
104     {
105         return false;
106     }
107 
108     /***
109      * setRegexp - set regexp flag for interpreting options
110      *
111      * @param regexp regexp flag
112      */
113     public void setRegexp(boolean regexp)
114     {
115         throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
116     }
117 
118     /***
119      * getProfile - get profile locator used to filter options
120      *
121      * @return profile locator name
122      */
123     public String getProfile()
124     {
125         return null;
126     }
127 
128     /***
129      * setProfile - set profile locator used to filter options
130      *
131      * @param locatorName profile locator name
132      */
133     public void setProfile(String locatorName)
134     {
135         throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
136     }
137 
138     /***
139      * getOrder - get comma separated regexp ordering patterns
140      *
141      * @return ordering patterns list
142      */
143     public String getOrder()
144     {
145         return null;
146     }
147 
148     /***
149      * setOrder - set comma separated regexp ordering patterns
150      *
151      * @param order ordering patterns list
152      */
153     public void setOrder(String order)
154     {
155         throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
156     }
157 
158     /***
159      * getSkin - get skin name for options
160      *
161      * @return skin name
162      */
163     public String getSkin()
164     {
165         return null;
166     }
167 
168     /***
169      * setSkin - set skin name for options
170      *
171      * @param name skin name
172      */
173     public void setSkin(String name)
174     {
175         throw new RuntimeException("StandardMenuOptionsDefinitionImpl instance immutable");
176     }
177 }