2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.

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  /*
19   * $Id: AbstractBean.java 464373 2006-10-16 04:21:54Z rahul $
20   */
21  package org.apache.shale.clay.config.beans;
22  
23  import java.io.Serializable;
24  
25  /***
26   * <p>Abstract class that provides a <code>description</code> property
27   * that is populated from the clay configuration file
28   * when design time tool support is enabled.</p>
29   *
30   */
31  public abstract class AbstractBean implements Serializable {
32      /***
33       * <p>Metadata description provided in the clay configuration.</p>
34       */
35      private String description = null;
36  
37      /***
38       * <p>Returns the <code>description</code> of the bean.</p>
39       *
40       * @return description of the config bean
41       */
42      public String getDescription() {
43          return description;
44      }
45  
46      /***
47       * <p>Sets the <code>description</code> of the bean.</p>
48       *
49       * @param description of the config bean
50       */
51      public void setDescription(String description) {
52          this.description = description;
53      }
54  
55  }