com.exalead.mercury.mami.indexing.v10

Class ListDocumentInfos

java.lang.Object

com.exalead.mercury.mami.indexing.v10.ListDocumentInfos

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ListDocumentInfos
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Lists the urls and stamps of the documents in a build group.
Warning: This method is heavy. We recommend to use the PAPI instead.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	numberOfElements
java.lang.String	prefix
int	start

Constructor Summary

Constructors

Constructor and Description
ListDocumentInfos()
ListDocumentInfos(ListDocumentInfos o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ListDocumentInfos.
static ListDocumentInfos	fromString(java.lang.String s) String representation of this ListDocumentInfos.
int	getNumberOfElements()
java.lang.String	getPrefix() Lists only the URLs starting with this prefix. Please note that URLs in the system are prefixed by connectorName:.//
int	getStart()
ListDocumentInfos	makeCopy() Creates and returns a deep copy of this ListDocumentInfos.
static ListDocumentInfos	readFrom(java.io.InputStream is) Read this ListDocumentInfos from an XML fragment.
void	setNumberOfElements(int numberOfElements)
void	setPrefix(java.lang.String prefix) Lists only the URLs starting with this prefix. Please note that URLs in the system are prefixed by connectorName:.//
void	setStart(int start)
java.lang.String	toString() String representation of this ListDocumentInfos.
ListDocumentInfos	withNumberOfElements(int numberOfElements)
ListDocumentInfos	withNumberOfElements(java.lang.Integer numberOfElements)
ListDocumentInfos	withPrefix(java.lang.String prefix)
ListDocumentInfos	withStart(int start)
ListDocumentInfos	withStart(java.lang.Integer start)
void	writeTo(java.io.OutputStream os) Write this ListDocumentInfos as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

prefix

public java.lang.String prefix

start

public int start

numberOfElements

public int numberOfElements

Constructor Detail

ListDocumentInfos

public ListDocumentInfos()

ListDocumentInfos

public ListDocumentInfos(ListDocumentInfos o)

Copy constructor

Method Detail

setPrefix

public void setPrefix(java.lang.String prefix)

Lists only the URLs starting with this prefix.
Please note that URLs in the system are prefixed by connectorName:.//

getPrefix

public java.lang.String getPrefix()

Lists only the URLs starting with this prefix.
Please note that URLs in the system are prefixed by connectorName:.//

withPrefix

public ListDocumentInfos withPrefix(java.lang.String prefix)

setStart

public void setStart(int start)

getStart

public int getStart()

withStart

public ListDocumentInfos withStart(int start)

withStart

public ListDocumentInfos withStart(java.lang.Integer start)

setNumberOfElements

public void setNumberOfElements(int numberOfElements)

getNumberOfElements

public int getNumberOfElements()

withNumberOfElements

public ListDocumentInfos withNumberOfElements(int numberOfElements)

withNumberOfElements

public ListDocumentInfos withNumberOfElements(java.lang.Integer numberOfElements)

makeCopy

public ListDocumentInfos makeCopy()

Creates and returns a deep copy of this ListDocumentInfos.

readFrom

public static ListDocumentInfos readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this ListDocumentInfos from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ListDocumentInfos as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ListDocumentInfos fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this ListDocumentInfos.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ListDocumentInfos.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ListDocumentInfos.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException