com.evernote.edam.notestore
Class SyncChunk

java.lang.Object
  com.evernote.edam.notestore.SyncChunk

All Implemented Interfaces:

TBase<SyncChunk>, Serializable, Cloneable, Comparable<SyncChunk>

public class SyncChunk
extends Object
implements TBase<SyncChunk>, Serializable, Cloneable

This structure is given out by the NoteStore when a client asks to receive the current state of an account. The client asks for the server's state one chunk at a time in order to allow clients to retrieve the state of a large account without needing to transfer the entire account in a single message. The server always gives SyncChunks using an ascending series of Update Sequence Numbers (USNs).

currentTime

The server's current date and time.

chunkHighUSN

The highest USN for any of the data objects represented in this sync chunk. If there are no objects in the chunk, this will not be set.

updateCount

The total number of updates that have been performed in the service for this account. This is equal to the highest USN within the account at the point that this SyncChunk was generated. If updateCount and chunkHighUSN are identical, that means that this is the last chunk in the account ... there is no more recent information.

notes

If present, this is a list of non-expunged notes that have a USN in this chunk. This will include notes that are "deleted" but not expunged (i.e. in the trash). The notes will include their list of tags and resources, but the note content, resource content, resource recognition data and resource alternate data will not be supplied.

notebooks

If present, this is a list of non-expunged notebooks that have a USN in this chunk. This will include notebooks that are "deleted" but not expunged (i.e. in the trash).

tags

If present, this is a list of the non-expunged tags that have a USN in this chunk.

searches

If present, this is a list of non-expunged searches that have a USN in this chunk.

resources

If present, this is a list of the non-expunged resources that have a USN in this chunk. This will include the metadata for each resource, but not its binary contents or recognition data, which must be retrieved separately.

expungedNotes

If present, the GUIDs of all of the notes that were permanently expunged in this chunk.

expungedNotebooks

If present, the GUIDs of all of the notebooks that were permanently expunged in this chunk. When a notebook is expunged, this implies that all of its child notes (and their resources) were also expunged.

expungedTags

If present, the GUIDs of all of the tags that were permanently expunged in this chunk.

expungedSearches

If present, the GUIDs of all of the saved searches that were permanently expunged in this chunk.

linkedNotebooks

If present, this is a list of non-expunged LinkedNotebooks that have a USN in this chunk.

expungedLinkedNotebooks

If present, the GUIDs of all of the LinkedNotebooks that were permanently expunged in this chunk.

See Also:

Serialized Form

Constructor Summary

SyncChunk()

SyncChunk(long currentTime, int updateCount)

SyncChunk(SyncChunk other)
Performs a deep copy on other.

Method Summary

void	addToExpungedLinkedNotebooks(String elem)
void	addToExpungedNotebooks(String elem)
void	addToExpungedNotes(String elem)
void	addToExpungedSearches(String elem)
void	addToExpungedTags(String elem)
void	addToLinkedNotebooks(LinkedNotebook elem)
void	addToNotebooks(Notebook elem)
void	addToNotes(Note elem)
void	addToResources(Resource elem)
void	addToSearches(SavedSearch elem)
void	addToTags(Tag elem)
void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(SyncChunk other)
SyncChunk	deepCopy() Creates a deep copy of the object.
boolean	equals(Object that)
boolean	equals(SyncChunk that)
int	getChunkHighUSN()
long	getCurrentTime()
List<String>	getExpungedLinkedNotebooks()
Iterator<String>	getExpungedLinkedNotebooksIterator()
int	getExpungedLinkedNotebooksSize()
List<String>	getExpungedNotebooks()
Iterator<String>	getExpungedNotebooksIterator()
int	getExpungedNotebooksSize()
List<String>	getExpungedNotes()
Iterator<String>	getExpungedNotesIterator()
int	getExpungedNotesSize()
List<String>	getExpungedSearches()
Iterator<String>	getExpungedSearchesIterator()
int	getExpungedSearchesSize()
List<String>	getExpungedTags()
Iterator<String>	getExpungedTagsIterator()
int	getExpungedTagsSize()
List<LinkedNotebook>	getLinkedNotebooks()
Iterator<LinkedNotebook>	getLinkedNotebooksIterator()
int	getLinkedNotebooksSize()
List<Notebook>	getNotebooks()
Iterator<Notebook>	getNotebooksIterator()
int	getNotebooksSize()
List<Note>	getNotes()
Iterator<Note>	getNotesIterator()
int	getNotesSize()
List<Resource>	getResources()
Iterator<Resource>	getResourcesIterator()
int	getResourcesSize()
List<SavedSearch>	getSearches()
Iterator<SavedSearch>	getSearchesIterator()
int	getSearchesSize()
List<Tag>	getTags()
Iterator<Tag>	getTagsIterator()
int	getTagsSize()
int	getUpdateCount()
int	hashCode()
boolean	isSetChunkHighUSN() Returns true if field chunkHighUSN is set (has been asigned a value) and false otherwise
boolean	isSetCurrentTime() Returns true if field currentTime is set (has been asigned a value) and false otherwise
boolean	isSetExpungedLinkedNotebooks() Returns true if field expungedLinkedNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetExpungedNotebooks() Returns true if field expungedNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetExpungedNotes() Returns true if field expungedNotes is set (has been asigned a value) and false otherwise
boolean	isSetExpungedSearches() Returns true if field expungedSearches is set (has been asigned a value) and false otherwise
boolean	isSetExpungedTags() Returns true if field expungedTags is set (has been asigned a value) and false otherwise
boolean	isSetLinkedNotebooks() Returns true if field linkedNotebooks is set (has been asigned a value) and false otherwise
boolean	isSetNotebooks() Returns true if field notebooks is set (has been asigned a value) and false otherwise
boolean	isSetNotes() Returns true if field notes is set (has been asigned a value) and false otherwise
boolean	isSetResources() Returns true if field resources is set (has been asigned a value) and false otherwise
boolean	isSetSearches() Returns true if field searches is set (has been asigned a value) and false otherwise
boolean	isSetTags() Returns true if field tags is set (has been asigned a value) and false otherwise
boolean	isSetUpdateCount() Returns true if field updateCount is set (has been asigned a value) and false otherwise
void	read(TProtocol iprot) Reads an instance of the object from the given protocol.
void	setChunkHighUSN(int chunkHighUSN)
void	setChunkHighUSNIsSet(boolean value)
void	setCurrentTime(long currentTime)
void	setCurrentTimeIsSet(boolean value)
void	setExpungedLinkedNotebooks(List<String> expungedLinkedNotebooks)
void	setExpungedLinkedNotebooksIsSet(boolean value)
void	setExpungedNotebooks(List<String> expungedNotebooks)
void	setExpungedNotebooksIsSet(boolean value)
void	setExpungedNotes(List<String> expungedNotes)
void	setExpungedNotesIsSet(boolean value)
void	setExpungedSearches(List<String> expungedSearches)
void	setExpungedSearchesIsSet(boolean value)
void	setExpungedTags(List<String> expungedTags)
void	setExpungedTagsIsSet(boolean value)
void	setLinkedNotebooks(List<LinkedNotebook> linkedNotebooks)
void	setLinkedNotebooksIsSet(boolean value)
void	setNotebooks(List<Notebook> notebooks)
void	setNotebooksIsSet(boolean value)
void	setNotes(List<Note> notes)
void	setNotesIsSet(boolean value)
void	setResources(List<Resource> resources)
void	setResourcesIsSet(boolean value)
void	setSearches(List<SavedSearch> searches)
void	setSearchesIsSet(boolean value)
void	setTags(List<Tag> tags)
void	setTagsIsSet(boolean value)
void	setUpdateCount(int updateCount)
void	setUpdateCountIsSet(boolean value)
String	toString()
void	unsetChunkHighUSN()
void	unsetCurrentTime()
void	unsetExpungedLinkedNotebooks()
void	unsetExpungedNotebooks()
void	unsetExpungedNotes()
void	unsetExpungedSearches()
void	unsetExpungedTags()
void	unsetLinkedNotebooks()
void	unsetNotebooks()
void	unsetNotes()
void	unsetResources()
void	unsetSearches()
void	unsetTags()
void	unsetUpdateCount()
void	validate()
void	write(TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SyncChunk

public SyncChunk()

SyncChunk

public SyncChunk(long currentTime,
                 int updateCount)

SyncChunk

public SyncChunk(SyncChunk other)

Performs a deep copy on other.

Method Detail

deepCopy

public SyncChunk deepCopy()

Description copied from interface: TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface TBase<SyncChunk>

clear

public void clear()

Description copied from interface: TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface TBase<SyncChunk>

getCurrentTime

public long getCurrentTime()

setCurrentTime

public void setCurrentTime(long currentTime)

unsetCurrentTime

public void unsetCurrentTime()

isSetCurrentTime

public boolean isSetCurrentTime()

Returns true if field currentTime is set (has been asigned a value) and false otherwise

setCurrentTimeIsSet

public void setCurrentTimeIsSet(boolean value)

getChunkHighUSN

public int getChunkHighUSN()

setChunkHighUSN

public void setChunkHighUSN(int chunkHighUSN)

unsetChunkHighUSN

public void unsetChunkHighUSN()

isSetChunkHighUSN

public boolean isSetChunkHighUSN()

Returns true if field chunkHighUSN is set (has been asigned a value) and false otherwise

setChunkHighUSNIsSet

public void setChunkHighUSNIsSet(boolean value)

getUpdateCount

public int getUpdateCount()

setUpdateCount

public void setUpdateCount(int updateCount)

unsetUpdateCount

public void unsetUpdateCount()

isSetUpdateCount

public boolean isSetUpdateCount()

Returns true if field updateCount is set (has been asigned a value) and false otherwise

setUpdateCountIsSet

public void setUpdateCountIsSet(boolean value)

getNotesSize

public int getNotesSize()

getNotesIterator

public Iterator<Note> getNotesIterator()

addToNotes

public void addToNotes(Note elem)

getNotes

public List<Note> getNotes()

setNotes

public void setNotes(List<Note> notes)

unsetNotes

public void unsetNotes()

isSetNotes

public boolean isSetNotes()

Returns true if field notes is set (has been asigned a value) and false otherwise

setNotesIsSet

public void setNotesIsSet(boolean value)

getNotebooksSize

public int getNotebooksSize()

getNotebooksIterator

public Iterator<Notebook> getNotebooksIterator()

addToNotebooks

public void addToNotebooks(Notebook elem)

getNotebooks

public List<Notebook> getNotebooks()

setNotebooks

public void setNotebooks(List<Notebook> notebooks)

unsetNotebooks

public void unsetNotebooks()

isSetNotebooks

public boolean isSetNotebooks()

Returns true if field notebooks is set (has been asigned a value) and false otherwise

setNotebooksIsSet

public void setNotebooksIsSet(boolean value)

getTagsSize

public int getTagsSize()

getTagsIterator

public Iterator<Tag> getTagsIterator()

addToTags

public void addToTags(Tag elem)

getTags

public List<Tag> getTags()

setTags

public void setTags(List<Tag> tags)

unsetTags

public void unsetTags()

isSetTags

public boolean isSetTags()

Returns true if field tags is set (has been asigned a value) and false otherwise

setTagsIsSet

public void setTagsIsSet(boolean value)

getSearchesSize

public int getSearchesSize()

getSearchesIterator

public Iterator<SavedSearch> getSearchesIterator()

addToSearches

public void addToSearches(SavedSearch elem)

getSearches

public List<SavedSearch> getSearches()

setSearches

public void setSearches(List<SavedSearch> searches)

unsetSearches

public void unsetSearches()

isSetSearches

public boolean isSetSearches()

Returns true if field searches is set (has been asigned a value) and false otherwise

setSearchesIsSet

public void setSearchesIsSet(boolean value)

getResourcesSize

public int getResourcesSize()

getResourcesIterator

public Iterator<Resource> getResourcesIterator()

addToResources

public void addToResources(Resource elem)

getResources

public List<Resource> getResources()

setResources

public void setResources(List<Resource> resources)

unsetResources

public void unsetResources()

isSetResources

public boolean isSetResources()

Returns true if field resources is set (has been asigned a value) and false otherwise

setResourcesIsSet

public void setResourcesIsSet(boolean value)

getExpungedNotesSize

public int getExpungedNotesSize()

getExpungedNotesIterator

public Iterator<String> getExpungedNotesIterator()

addToExpungedNotes

public void addToExpungedNotes(String elem)

getExpungedNotes

public List<String> getExpungedNotes()

setExpungedNotes

public void setExpungedNotes(List<String> expungedNotes)

unsetExpungedNotes

public void unsetExpungedNotes()

isSetExpungedNotes

public boolean isSetExpungedNotes()

Returns true if field expungedNotes is set (has been asigned a value) and false otherwise

setExpungedNotesIsSet

public void setExpungedNotesIsSet(boolean value)

getExpungedNotebooksSize

public int getExpungedNotebooksSize()

getExpungedNotebooksIterator

public Iterator<String> getExpungedNotebooksIterator()

addToExpungedNotebooks

public void addToExpungedNotebooks(String elem)

getExpungedNotebooks

public List<String> getExpungedNotebooks()

setExpungedNotebooks

public void setExpungedNotebooks(List<String> expungedNotebooks)

unsetExpungedNotebooks

public void unsetExpungedNotebooks()

isSetExpungedNotebooks

public boolean isSetExpungedNotebooks()

Returns true if field expungedNotebooks is set (has been asigned a value) and false otherwise

setExpungedNotebooksIsSet

public void setExpungedNotebooksIsSet(boolean value)

getExpungedTagsSize

public int getExpungedTagsSize()

getExpungedTagsIterator

public Iterator<String> getExpungedTagsIterator()

addToExpungedTags

public void addToExpungedTags(String elem)

getExpungedTags

public List<String> getExpungedTags()

setExpungedTags

public void setExpungedTags(List<String> expungedTags)

unsetExpungedTags

public void unsetExpungedTags()

isSetExpungedTags

public boolean isSetExpungedTags()

Returns true if field expungedTags is set (has been asigned a value) and false otherwise

setExpungedTagsIsSet

public void setExpungedTagsIsSet(boolean value)

getExpungedSearchesSize

public int getExpungedSearchesSize()

getExpungedSearchesIterator

public Iterator<String> getExpungedSearchesIterator()

addToExpungedSearches

public void addToExpungedSearches(String elem)

getExpungedSearches

public List<String> getExpungedSearches()

setExpungedSearches

public void setExpungedSearches(List<String> expungedSearches)

unsetExpungedSearches

public void unsetExpungedSearches()

isSetExpungedSearches

public boolean isSetExpungedSearches()

Returns true if field expungedSearches is set (has been asigned a value) and false otherwise

setExpungedSearchesIsSet

public void setExpungedSearchesIsSet(boolean value)

getLinkedNotebooksSize

public int getLinkedNotebooksSize()

getLinkedNotebooksIterator

public Iterator<LinkedNotebook> getLinkedNotebooksIterator()

addToLinkedNotebooks

public void addToLinkedNotebooks(LinkedNotebook elem)

getLinkedNotebooks

public List<LinkedNotebook> getLinkedNotebooks()

setLinkedNotebooks

public void setLinkedNotebooks(List<LinkedNotebook> linkedNotebooks)

unsetLinkedNotebooks

public void unsetLinkedNotebooks()

isSetLinkedNotebooks

public boolean isSetLinkedNotebooks()

Returns true if field linkedNotebooks is set (has been asigned a value) and false otherwise

setLinkedNotebooksIsSet

public void setLinkedNotebooksIsSet(boolean value)

getExpungedLinkedNotebooksSize

public int getExpungedLinkedNotebooksSize()

getExpungedLinkedNotebooksIterator

public Iterator<String> getExpungedLinkedNotebooksIterator()

addToExpungedLinkedNotebooks

public void addToExpungedLinkedNotebooks(String elem)

getExpungedLinkedNotebooks

public List<String> getExpungedLinkedNotebooks()

setExpungedLinkedNotebooks

public void setExpungedLinkedNotebooks(List<String> expungedLinkedNotebooks)

unsetExpungedLinkedNotebooks

public void unsetExpungedLinkedNotebooks()

isSetExpungedLinkedNotebooks

public boolean isSetExpungedLinkedNotebooks()

Returns true if field expungedLinkedNotebooks is set (has been asigned a value) and false otherwise

setExpungedLinkedNotebooksIsSet

public void setExpungedLinkedNotebooksIsSet(boolean value)

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(SyncChunk that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(SyncChunk other)

Specified by:

compareTo in interface Comparable<SyncChunk>

read

public void read(TProtocol iprot)
          throws TException

Description copied from interface: TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface TBase<SyncChunk>

Parameters:

iprot - Input protocol

Throws:

TException

write

public void write(TProtocol oprot)
           throws TException

Description copied from interface: TBase

Writes the object to the given protocol.

Specified by:

write in interface TBase<SyncChunk>

Parameters:

oprot - Output protocol

Throws:

TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws TException

Throws:

TException