|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.modeshape.jcr.federation.spi.PageKey
public final class PageKey
The key used to uniquely identify a page of children. A page key is formed by joining together the id of the owning document, the offset of the page and the size of the block.
Constructor Summary | |
---|---|
PageKey(String key)
Creates a new instance from a raw string, which is expected to contain 3 parts, each representing a piece of information |
|
PageKey(String parentId,
String offset,
long blockSize)
|
Method Summary | |
---|---|
long |
getBlockSize()
Returns the size of the block |
Integer |
getOffsetInt()
Returns the integer representation of the offset, if the offset is convertible to an integer. |
String |
getOffsetString()
Returns the offset of the block, which semantically represents a pointer to the start of the block. |
String |
getParentId()
Returns the id of the document which owns the block and effectively the list of children, |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PageKey(String key)
key
- a non-null
string
IllegalArgumentException
- if the string is not correctly formed.public PageKey(String parentId, String offset, long blockSize)
Method Detail |
---|
public long getBlockSize()
public String getOffsetString()
non-null
Stringpublic Integer getOffsetInt()
null
is returned.
public String getParentId()
non-null
Stringpublic String toString()
toString
in class Object
|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |