Package net.webpdf.wsclient.openapi

Class MetadataMarkup

java.lang.Object

net.webpdf.wsclient.openapi.MetadataMarkup

public class MetadataMarkup
extends Object

Defines a set of attributes for text markup annotations.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CREATION_DATE
static String	JSON_PROPERTY_CREATOR
static String	JSON_PROPERTY_INTENTS
static String	JSON_PROPERTY_OPACITY
static String	JSON_PROPERTY_RELATION
static String	JSON_PROPERTY_RICH_CONTENTS
static String	JSON_PROPERTY_SUBJECT

Constructor Summary

Constructors

Constructor	Description
MetadataMarkup()

Method Summary

Modifier and Type	Method	Description
MetadataMarkup	creationDate(String creationDate)
MetadataMarkup	creator(String creator)
boolean	equals(Object o)
@Nullable String	getCreationDate()	The date of the annotation's creation.
@Nullable String	getCreator()	The name of the annotation's author.
@Nullable String	getIntents()	The annotation's intents.
@Nullable Integer	getOpacity()	The annotations opacity as a percentage, where 100 is fully oqaque and 0 is fully transparent.
@Nullable MetadataRelationMarkup	getRelation()	Get relation
@Nullable String	getRichContents()	A richtext string containing defining style and contents of the annotation.
@Nullable String	getSubject()	The annotation's subject.
int	hashCode()
MetadataMarkup	intents(String intents)
MetadataMarkup	opacity(Integer opacity)
MetadataMarkup	relation(MetadataRelationMarkup relation)
MetadataMarkup	richContents(String richContents)
void	setCreationDate(String creationDate)
void	setCreator(String creator)
void	setIntents(String intents)
void	setOpacity(Integer opacity)
void	setRelation(MetadataRelationMarkup relation)
void	setRichContents(String richContents)
void	setSubject(String subject)
MetadataMarkup	subject(String subject)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_CREATION_DATE

public static final String JSON_PROPERTY_CREATION_DATE

See Also:

Constant Field Values

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

See Also:

Constant Field Values

JSON_PROPERTY_INTENTS

public static final String JSON_PROPERTY_INTENTS

See Also:

Constant Field Values

JSON_PROPERTY_OPACITY

public static final String JSON_PROPERTY_OPACITY

See Also:

Constant Field Values

JSON_PROPERTY_RELATION

public static final String JSON_PROPERTY_RELATION

See Also:

Constant Field Values

JSON_PROPERTY_RICH_CONTENTS

public static final String JSON_PROPERTY_RICH_CONTENTS

See Also:

Constant Field Values

JSON_PROPERTY_SUBJECT

public static final String JSON_PROPERTY_SUBJECT

See Also:

Constant Field Values

Constructor Detail

MetadataMarkup

public MetadataMarkup()

Method Detail

creationDate

public MetadataMarkup creationDate(String creationDate)

getCreationDate

@Nullable
public @Nullable String getCreationDate()

The date of the annotation's creation. This string will contain the date in ASN.1 standard format. (D:YYYYMMDDHHmmSSOHH'mm)

Returns:

creationDate

setCreationDate

public void setCreationDate(String creationDate)

creator

public MetadataMarkup creator(String creator)

getCreator

@Nullable
public @Nullable String getCreator()

The name of the annotation's author.

Returns:

creator

setCreator

public void setCreator(String creator)

intents

public MetadataMarkup intents(String intents)

getIntents

@Nullable
public @Nullable String getIntents()

The annotation's intents. Depending on the annotation sub type the intents value shall serve further purposes.

Returns:

intents

setIntents

public void setIntents(String intents)

opacity

public MetadataMarkup opacity(Integer opacity)

getOpacity

@Nullable
public @Nullable Integer getOpacity()

The annotations opacity as a percentage, where 100 is fully oqaque and 0 is fully transparent. minimum: 0 maximum: 100

Returns:

opacity

setOpacity

public void setOpacity(Integer opacity)

relation

public MetadataMarkup relation(MetadataRelationMarkup relation)

getRelation

@Nullable
public @Nullable MetadataRelationMarkup getRelation()

Get relation

Returns:

relation

setRelation

public void setRelation(MetadataRelationMarkup relation)

richContents

public MetadataMarkup richContents(String richContents)

getRichContents

@Nullable
public @Nullable String getRichContents()

A richtext string containing defining style and contents of the annotation. (This String shall conform to the richtext conventions of the XML Forms Specification (XFA)).

Returns:

richContents

setRichContents

public void setRichContents(String richContents)

subject

public MetadataMarkup subject(String subject)

getSubject

@Nullable
public @Nullable String getSubject()

The annotation's subject.

Returns:

subject

setSubject

public void setSubject(String subject)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object