Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

services
Class YamService

java.lang.Object
  services.YamService

class YamService

This service encapsulates logic relating to YamFiles (and other files in Wiki areas) and their interdependencies.

Property Summary
static Map conf

Config

static def scope

Scoping

boolean transactional

Non-transactional

String yamSyntax

The YAM syntax summary.

 
Constructor Summary
YamService()

 
Method Summary
YamFile generate(String path, boolean doIncludes, Map thisPage)

Generate HTML for YAM file.

YamFile generate(YamFile yam, boolean doIncludes, Map thisPage)

Generate HTML for YAM file.

YamFile generate(YamFile yam, boolean doIncludes, String contextPath)

Generate HTML for YAM file.

void queueRegenerations(Set dirtyList, Map thisPage)

Queue the regeneration of a set of YamFiles.

String syntax()

Return the YAM syntax summary.

 
Methods inherited from class Object
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll
 

Property Detail

conf

static Map conf
Config

scope

static def scope
Scoping

transactional

boolean transactional
Non-transactional

yamSyntax

String yamSyntax
The YAM syntax summary.

 
Constructor Detail

YamService

YamService()

 
Method Detail

generate

YamFile generate(String path, boolean doIncludes, Map thisPage)
Generate HTML for YAM file.
param:
path The path to the YAM file.
param:
doIncludes Should we process includes?
param:
thisPage The page model map.

generate

YamFile generate(YamFile yam, boolean doIncludes, Map thisPage)
Generate HTML for YAM file.
param:
path The path to the YAM file.
param:
doIncludes Should we process includes?
param:
thisPage The page model map.

generate

YamFile generate(YamFile yam, boolean doIncludes, String contextPath)
Generate HTML for YAM file.
param:
path The path to the YAM file.
param:
doIncludes Should we process includes?
param:
String contextPath

queueRegenerations

void queueRegenerations(Set dirtyList, Map thisPage)
Queue the regeneration of a set of YamFiles.
param:
dirtyList The list of files to regenerate.
param:
thisPage The page model map.

syntax

String syntax()
Return the YAM syntax summary.

 

Groovy Documentation