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 java.util.Locale;
20  
21  import org.apache.jetspeed.om.folder.MenuSeparatorDefinition;
22  import org.apache.jetspeed.om.common.GenericMetadata;
23  
24  /***
25   * This abstract class implements the menu separator definition
26   * interface in a default manner to allow derived classes to
27   * easily describe standard menu definitions.
28   * 
29   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
30   * @version $Id: StandardMenuSeparatorDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $
31   */
32  public abstract class StandardMenuSeparatorDefinitionImpl implements MenuSeparatorDefinition
33  {
34      /***
35       * StandardMenuSeparatorDefinitionImpl - constructor
36       */
37      public StandardMenuSeparatorDefinitionImpl()
38      {
39      }
40  
41      /***
42       * getSkin - get skin name for separator
43       *
44       * @return skin name
45       */
46      public String getSkin()
47      {
48          return null;
49      }
50  
51      /***
52       * setSkin - set skin name for separator
53       *
54       * @param name skin name
55       */
56      public void setSkin(String name)
57      {
58          throw new RuntimeException("StandardMenuSeparatorDefinitionImpl instance immutable");        
59      }
60  
61      /***
62       * getTitle - get default title for separator
63       *
64       * @return title text
65       */
66      public String getTitle()
67      {
68          return null;
69      }
70  
71      /***
72       * setTitle - set default title for separator
73       *
74       * @param title title text
75       */
76      public void setTitle(String title)
77      {
78          throw new RuntimeException("StandardMenuSeparatorDefinitionImpl instance immutable");        
79      }
80  
81      /***
82       * getText - get default text for separator
83       *
84       * @return text
85       */
86      public String getText()
87      {
88          return null;
89      }
90  
91      /***
92       * setText - set default text for separator
93       *
94       * @param text text
95       */
96      public void setText(String text)
97      {
98          throw new RuntimeException("StandardMenuSeparatorDefinitionImpl instance immutable");        
99      }
100 
101     /***
102      * getTitle - get locale specific title for separator from metadata
103      *
104      * @param locale preferred locale
105      * @return title text
106      */
107     public String getTitle(Locale locale)
108     {
109         return getTitle();
110     }
111 
112     /***
113      * getText - get locale specific text for separator from metadata
114      *
115      * @param locale preferred locale
116      * @return text
117      */
118     public String getText(Locale locale)
119     {
120         return getText();
121     }
122 
123     /***
124      * getMetadata - get generic metadata instance for menu
125      *
126      * @return metadata instance
127      */
128     public GenericMetadata getMetadata()
129     {
130         return null;
131     }
132 }