org.gedcomx.test

Class Recipe

java.lang.Object

org.gedcomx.test.Recipe

public class Recipe
extends Object

A recipe for doing something specific with the model.

Author:

Mike Gardiner, Ryan Heaton

Constructor Summary

Constructors

Constructor and Description
Recipe()

Method Summary

Modifier and Type	Method and Description
void	addSnippet(Snippet snippet) Add a code snippet.
Recipe	applicableTo(Class<?> type) Add a type for which this recipe is applicable.
Set<String>	getApplicableTypes() The set of fully-qualified names of types to which this recipe is applicable.
String	getDescription()
List<Snippet>	getSnippets() Code snippets for the recipe.
String	getTitle()
void	setDescription(String description)
void	setTitle(String title)
Recipe	withDescription(String description)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Recipe

public Recipe()

Method Detail

getTitle

public String getTitle()

Returns:

Title of the recipe

setTitle

public void setTitle(String title)

Parameters:

title - - The recipe title

withDescription

public Recipe withDescription(String description)

Parameters:

description - - A description to associate with the recipe

Returns:

The associated recipe

getDescription

public String getDescription()

Returns:

Description of the recipe

setDescription

public void setDescription(String description)

Parameters:

description - - Description to assign to the recipe

addSnippet

public void addSnippet(Snippet snippet)

Add a code snippet.

Parameters:

snippet - The code snippet to add.

getSnippets

public List<Snippet> getSnippets()

Code snippets for the recipe.

Returns:

The code snippets.

applicableTo

public Recipe applicableTo(Class<?> type)

Add a type for which this recipe is applicable.

Parameters:

type - The type for which this recipe is applicable.

Returns:

this recipe.

getApplicableTypes

public Set<String> getApplicableTypes()

The set of fully-qualified names of types to which this recipe is applicable.

Returns:

The set of fully-qualified names of types to which this recipe is applicable.