001    // Copyright 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.describe;
016    
017    /**
018     * An object that can describe its properties to a
019     * {@link org.apache.tapestry.describe.DescriptionReceiver}.
020     * 
021     * @author Howard M. Lewis Ship
022     * @since 4.0
023     */
024    public interface Describable
025    {
026    
027        /**
028         * Invoked to have the receiver describe itself (largely in terms of
029         * properties and values). If the caller does not invoke any methods on the
030         * receiver, then the a default description of the caller will be used
031         * (based on <code>toString()</code>.
032         */
033        void describeTo(DescriptionReceiver receiver);
034    }