    001    // Copyright 2007, 2008 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.tapestry5.services;
    016
    017    import org.apache.tapestry5.MarkupWriter;
    018    import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration;
    019
    020    /**
    021     * A strategy interface used for converting an object into markup that describes that object. This is primarily used in
    022     * terms of an {@link org.apache.tapestry5.services.ExceptionReporter} page.
    023     * <p/>
    024     * The ObjectRenderer service (distinguished by the @{@link org.apache.tapestry5.ioc.annotations.Primary} marker
    025     * annotation) uses {@linkplain org.apache.tapestry5.ioc.services.StrategyBuilder type-based matching} to find a
    026     * specific ObjectRenderer for any given type.
    027     */
    028    @UsesMappedConfiguration(key = Class.class, value = ObjectRenderer.class)
    029    public interface ObjectRenderer<T>
    030    {
    031        /**
    032         * Renders the object out as markup.
    033         *
    034         * @param object to be rendered
    035         * @param writer to which output should be directed
    036         */
    037        void render(T object, MarkupWriter writer);
    038    }