org.apache.wicket.util.template.TextTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * 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 org.apache.wicket.util.template;

import java.util.Map;

import org.apache.wicket.util.resource.AbstractStringResourceStream;
import org.apache.wicket.util.string.interpolator.MapVariableInterpolator;


/**
 * Represents a text template that can do variable interpolation.
 * 
 * @see org.apache.wicket.util.string.interpolator.VariableInterpolator
 * 
 * @author Eelco Hillenius
 * @author Jonathan Locke
 * @since 1.2.6
 */
public abstract class TextTemplate extends AbstractStringResourceStream
{
	private static final long serialVersionUID = 1L;

	/**
	 * Constructor.
	 */
	public TextTemplate()
	{
	}

	/**
	 * Constructor.
	 * 
	 * @param contentType
	 *            the mime type of this resource, such as "image/jpeg" or "
	 *            text/html"
	 */
	public TextTemplate(String contentType)
	{
		super(contentType);
	}

	/**
	 * Interpolates the Map of variables with the content and returns the resulting
	 * String without replacing the content. Variables are denoted in this string by
	 * the syntax ${variableName}. The contents will be altered by replacing each
	 * variable of the form ${variableName} with the value returned by
	 * variables.getValue("variableName").
	 * 
	 * @param variables
	 *            the variables to interpolate
	 * @return the result of the interpolation
	 */
	public String asString(Map variables)
	{
		if (variables != null)
		{
			return new MapVariableInterpolator(getString(), variables).toString();
		}
		return getString();
	}

	/**
	 * @see org.apache.wicket.util.resource.AbstractResourceStream#asString()
	 */
	@Override
	public String asString()
	{
		return getString();
	}

	/**
	 * Retrieves the String resource.
	 * 
	 * @return the String resource
	 */
	@Override
	public abstract String getString();

	/**
	 * Interpolates values into this TextTemplate.
	 * 
	 * @param variables
	 *            variables to interpolate into this TextTemplate
	 * @return this, for chaining purposes
	 */
	public abstract TextTemplate interpolate(Map variables);
}