org.apache.velocity.site.news.macro
Class VelocityNewsMacro

java.lang.Object
  extended by org.apache.maven.doxia.macro.AbstractMacro
      extended by org.apache.velocity.site.news.macro.VelocityNewsMacro
All Implemented Interfaces:
org.apache.maven.doxia.macro.Macro, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

public class VelocityNewsMacro
extends org.apache.maven.doxia.macro.AbstractMacro
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

apt usage: %{news}


Field Summary
 
Fields inherited from interface org.apache.maven.doxia.macro.Macro
ROLE
 
Constructor Summary
VelocityNewsMacro()
           
 
Method Summary
 void contextualize(org.codehaus.plexus.context.Context context)
           
 void execute(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.macro.MacroRequest request)
           
protected  void generateNewsBlock(org.apache.maven.doxia.sink.Sink sink, int maxCount)
           
protected  java.lang.String getParameter(org.apache.maven.doxia.macro.MacroRequest request, java.lang.String field, java.lang.String defaultValue)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VelocityNewsMacro

public VelocityNewsMacro()
Method Detail

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException
Specified by:
contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Throws:
org.codehaus.plexus.context.ContextException

execute

public void execute(org.apache.maven.doxia.sink.Sink sink,
                    org.apache.maven.doxia.macro.MacroRequest request)
             throws org.apache.maven.doxia.macro.MacroExecutionException
Specified by:
execute in interface org.apache.maven.doxia.macro.Macro
Throws:
org.apache.maven.doxia.macro.MacroExecutionException

getParameter

protected java.lang.String getParameter(org.apache.maven.doxia.macro.MacroRequest request,
                                        java.lang.String field,
                                        java.lang.String defaultValue)

generateNewsBlock

protected void generateNewsBlock(org.apache.maven.doxia.sink.Sink sink,
                                 int maxCount)
                          throws VelocityNewsException
Throws:
VelocityNewsException


Copyright © 2006-2007 The Apache Software Foundation. All Rights Reserved.