src/main/java/freemarker/ext/util/WrapperTemplateModel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package freemarker.ext.util;

import freemarker.template.TemplateModel;

/**
 * A generic interface for template models that wrap some underlying
 * object, and wish to provide access to that wrapped object.
 * 
 * <p>You may also want to implement {@link freemarker.template.AdapterTemplateModel}.
 */
public interface WrapperTemplateModel extends TemplateModel {
    /**
     * Retrieves the original object wrapped by this model.
     */
    public Object getWrappedObject();
}