com.allanbank.mongodb

Class ReadPreferenceEditor

java.lang.Object

java.beans.PropertyEditorSupport

com.allanbank.mongodb.ReadPreferenceEditor

All Implemented Interfaces:

PropertyEditor

public class ReadPreferenceEditor
extends PropertyEditorSupport

PropertyEditor for the ReadPreference class.

The string value must be one of the following tokens or a parsable JSON document in the form of ReadPreference.asDocument().

Valid tokens are:

• PRIMARY
• SECONDARY
• CLOSEST
• NEAREST
• PREFER_PRIMARY
• PREFER_SECONDARY

This editor will also parse a full MongoDB URI to extract the specified ReadPreference. See the Connection String URI Format documentation for information on constructing a MongoDB URI.

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 ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	LOG The logger for the ReadPreferenceEditor.
static Set<String>	MONGODB_URI_FIELDS The set of fields used to determine a Durability from a MongoDB URI.

Constructor Summary

Constructors

Constructor and Description
ReadPreferenceEditor() Creates a new ReadPreferenceEditor.

Method Summary

Methods

Modifier and Type	Method and Description
void	setAsText(String readPreferenceString)

Methods inherited from class java.beans.PropertyEditorSupport

addPropertyChangeListener, firePropertyChange, getAsText, getCustomEditor, getJavaInitializationString, getSource, getTags, getValue, isPaintable, paintValue, removePropertyChangeListener, setSource, setValue, supportsCustomEditor

Methods inherited from class java.lang.Object

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

Field Detail

MONGODB_URI_FIELDS

public static final Set<String> MONGODB_URI_FIELDS

The set of fields used to determine a Durability from a MongoDB URI.

LOG

protected static final Log LOG

The logger for the ReadPreferenceEditor.

Constructor Detail

ReadPreferenceEditor

public ReadPreferenceEditor()

Creates a new ReadPreferenceEditor.

Method Detail

setAsText

public void setAsText(String readPreferenceString)
               throws IllegalArgumentException

Overridden to parse a string to a ReadPreference.

Specified by:

setAsText in interface PropertyEditor

Overrides:

setAsText in class PropertyEditorSupport

Throws:

IllegalArgumentException - If the string cannot be parsed into a ReadPreference.