org.sejda.core.support.prefix.model

Class NameGenerationRequest

java.lang.Object

org.sejda.core.support.prefix.model.NameGenerationRequest

public final class NameGenerationRequest
extends Object

Request for a new name generation.

Author:

Andrea Vacondio

Method Summary

Modifier and Type	Method and Description
NameGenerationRequest	bookmark(String bookmark) Fluently sets the bookmark
NameGenerationRequest	fileNumber(int fileNumber) Fluently sets the file number
String	getBookmark()
String	getExtension()
Integer	getFileNumber()
String	getOriginalName()
Integer	getPage()
String	getText()
static NameGenerationRequest	nameRequest()
static NameGenerationRequest	nameRequest(String extension)
NameGenerationRequest	originalName(String originalName) Fluently sets the original file name
NameGenerationRequest	page(int page) Fluently sets the page
NameGenerationRequest	text(String text) Fluently sets the text.

Methods inherited from class java.lang.Object

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

Method Detail

nameRequest

public static NameGenerationRequest nameRequest()

Returns:

a newly created NameGenerationRequest where the generated name will have a pdf extension.

nameRequest

public static NameGenerationRequest nameRequest(String extension)

Parameters:

extension - the extension applied to the generated name, cannot be blank (Ex. pdf, txt).

Returns:

a newly created NameGenerationRequest

page

public NameGenerationRequest page(int page)

Fluently sets the page

Parameters:

page -

Returns:

the current instance

fileNumber

public NameGenerationRequest fileNumber(int fileNumber)

Fluently sets the file number

Parameters:

fileNumber -

Returns:

the current instance

bookmark

public NameGenerationRequest bookmark(String bookmark)

Fluently sets the bookmark

Parameters:

bookmark -

Returns:

the current instance

originalName

public NameGenerationRequest originalName(String originalName)

Fluently sets the original file name

Parameters:

originalName -

Returns:

the current instance

text

public NameGenerationRequest text(String text)

Fluently sets the text. Called when splitting by text content, passes in the text found in the rectangle box area on the page right before the split boundary.

Parameters:

text - strings found in page areas when splitting by text content

Returns:

the current instance

getPage

public Integer getPage()

getFileNumber

public Integer getFileNumber()

getBookmark

public String getBookmark()

getOriginalName

public String getOriginalName()

getExtension

public String getExtension()

getText

public String getText()