Package com.mongodb.bulk

Class WriteConcernError

java.lang.Object

com.mongodb.bulk.WriteConcernError

public class WriteConcernError
extends Object

An error representing a failure by the server to apply the requested write concern to the bulk operation.

Since:

3.0

MongoDB documentation

Write Concern

Constructor Summary

Constructors

Constructor	Description
WriteConcernError(int code, String codeName, String message, BsonDocument details)	Constructs a new instance.
WriteConcernError(int code, String codeName, String message, BsonDocument details, Set<String> errorLabels)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
void	addLabel(String errorLabel)	Adds the given error label to the exception.
boolean	equals(Object o)
int	getCode()	Gets the code associated with this error.
String	getCodeName()	Gets the name associated with the error code.
BsonDocument	getDetails()	Gets the details associated with this error.
Set<String>	getErrorLabels()	Gets the set of error labels associated with this exception.
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

WriteConcernError

public WriteConcernError(int code,
                         String codeName,
                         String message,
                         BsonDocument details)

Constructs a new instance.

Parameters:

code - the error code

codeName - the error code name

message - the error message

details - any details

WriteConcernError

public WriteConcernError(int code,
                         String codeName,
                         String message,
                         BsonDocument details,
                         Set<String> errorLabels)

Constructs a new instance.

Parameters:

code - the error code

codeName - the error code name

message - the error message

details - any details

errorLabels - any error labels

Since:

4.1

Method Detail

getCode

public int getCode()

Gets the code associated with this error.

Returns:

the code

getCodeName

public String getCodeName()

Gets the name associated with the error code.

Returns:

the error code name, which may be the empty string

Since:

3.8

Since server release

3.4

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

addLabel

public void addLabel(String errorLabel)

Adds the given error label to the exception.

Parameters:

errorLabel - the non-null error label to add to the exception

Since:

4.1

getErrorLabels

@NonNull
public Set<String> getErrorLabels()

Gets the set of error labels associated with this exception.

Returns:

the error labels, which may not be null but may be empty

Since:

4.1

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