com.allanbank.mongodb.error

Class DocumentToLargeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.allanbank.mongodb.MongoDbException

com.allanbank.mongodb.error.DocumentToLargeException

All Implemented Interfaces:

Serializable

public class DocumentToLargeException
extends MongoDbException

DocumentToLargeException is thrown to report that an attempt was made to serialize a Document that is over the maximum size limit.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
DocumentToLargeException(int size, int maximum, Document document) Creates a new DocumentToLargeException.

Method Summary

Methods

Modifier and Type	Method and Description
Document	getDocument() Returns the document that was too big.
int	getMaximumSize() Returns the maximum size for a document.
int	getSize() Returns the size of the document that violated the maximum size.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentToLargeException

public DocumentToLargeException(int size,
                        int maximum,
                        Document document)

Creates a new DocumentToLargeException.

Parameters:

size - The size of the document that violated the maximum size.

maximum - The maximum size for a document.

document - The document that was too big.

Method Detail

getDocument

public Document getDocument()

Returns the document that was too big.

Returns:

The document that was too big.

getMaximumSize

public int getMaximumSize()

Returns the maximum size for a document.

Returns:

The maximum size for a document.

getSize

public int getSize()

Returns the size of the document that violated the maximum size.

Returns:

The size of the document that violated the maximum size.