KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > describe > Describable


1 // Copyright 2005 The Apache Software Foundation
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14

15 package org.apache.tapestry.describe;
16
17 /**
18  * An object that can describe its properties to a
19  * {@link org.apache.tapestry.describe.DescriptionReceiver}.
20  *
21  * @author Howard M. Lewis Ship
22  * @since 4.0
23  */

24 public interface Describable
25 {
26     /**
27      * Invoked to have the receiver describe itself (largely in terms of properties and values). If
28      * the caller does not invoke any methods on the receiver, then the a default description of the
29      * caller will be used (based on <code>toString()</code>.
30      */

31     public void describeTo(DescriptionReceiver receiver);
32 }
Popular Tags