/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.template;
import java.lang.reflect.Type;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.rendering.syntax.Syntax;
/**
* The content of a template.
*
* @version $Id: 5633921dd5613a7fb067287a912e4547718daf45 $
* @since 7.0M1
*/
public interface TemplateContent
{
/**
* @return the source of the template
*/
String getContent();
/**
* @return the syntax of the content
*/
Syntax getSourceSyntax();
/**
* @return the syntax so set in the {@link org.xwiki.rendering.block.RawBlock}, note taken into account if a source
* syntax is provided
*/
Syntax getRawSyntax();
/**
* Return custom property with the provided name and converted (if needed) to the passed type.
*
* @param <T> the type of the value to return
* @param name the name of the property
* @param type the type of the property
* @return the property value in the provided type or null if none could be found
*/
<T> T getProperty(String name, Type type);
/**
* Return custom property with the provided name and converted (if needed) to the passed default value type. If the
* property does not exist the default value is returned.
*
* @param <T> the type of the value to return
* @param name the name of the property
* @param def the default value
* @return the property value in the provided default value type or the provided default value if none could be
* found
*/
<T> T getProperty(String name, T def);
/**
* @return the author of the template
*/
DocumentReference getAuthorReference();
}