public class DocData extends Object
| Modifier and Type | Field and Description |
|---|---|
protected Map<String,String> |
meta
This is the document meta data
|
protected List<String> |
notes |
protected static String |
TEMPLATE_DEFAULT |
| Constructor and Description |
|---|
DocData(String name,
String title,
String[] notes)
Create a new DocData object
|
| Modifier and Type | Method and Description |
|---|---|
void |
addNote(String note)
Add a note to the document
|
String |
getDefaultTemplatePath() |
Map<String,String> |
getMeta() |
String |
getMetaData(String key) |
List<String> |
getNotes() |
static boolean |
isBlank(String str) |
static boolean |
isValidName(String name) |
Map<String,Object> |
toMap() |
protected static final String TEMPLATE_DEFAULT
public DocData(String name, String title, String[] notes)
name - the name of the document (must be alphanumeric (includes _) and no spaces or special chars)title - [OPTIONAL] the title of the documentnotes - [OPTIONAL] an array of notes to add into the documentpublic Map<String,Object> toMap()
IllegalArgumentException - if the data cannot be turned into a valid mappublic String getDefaultTemplatePath()
public void addNote(String note)
note - the text of the notepublic static boolean isBlank(String str)
public static boolean isValidName(String name)
Copyright © 2009–2021 Opencast Project. All rights reserved.