Package com.mongodb

Class WriteError

java.lang.Object

com.mongodb.WriteError

Direct Known Subclasses:

BulkWriteError

public class WriteError
extends Object

Represents the details of a write error , e.g. a duplicate key error

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
WriteError(int code, String message, BsonDocument details)	Constructs a new instance.
WriteError(WriteError writeError)	Construct an instance that is a shallow copy of the given instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ErrorCategory	getCategory()	Gets the category of this error.
int	getCode()	Gets the code associated with this error.
BsonDocument	getDetails()	Gets the details associated with this error.
String	getMessage()	Gets the message associated with this error.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WriteError

public WriteError(int code,
                  String message,
                  BsonDocument details)

Constructs a new instance.

Parameters:

code - the error code

message - the error message

details - details about the error

WriteError

public WriteError(WriteError writeError)

Construct an instance that is a shallow copy of the given instance.

Parameters:

writeError - the write error to copy

Method Detail

getCategory

public ErrorCategory getCategory()

Gets the category of this error.

Returns:

the category of this write error

getCode

public int getCode()

Gets the code associated with this error.

Returns:

the code

getMessage

public String getMessage()

Gets the message associated with this error.

Returns:

the message

getDetails

public BsonDocument getDetails()

Gets the details associated with this error. This document will not be null, but may be empty.

Returns:

the details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object