Enum NoOpSynchronizer
- java.lang.Object
-
- java.lang.Enum<NoOpSynchronizer>
-
- org.apache.commons.configuration2.sync.NoOpSynchronizer
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<NoOpSynchronizer>
,Synchronizer
public enum NoOpSynchronizer extends java.lang.Enum<NoOpSynchronizer> implements Synchronizer
An implementation of the
Synchronizer
interface which does not perform any synchronization.This class is the option of choice for applications that do not access configuration concurrently. All methods required by the
Synchronizer
interface are just empty dummies. Therefore, this class does not have any synchronization overhead. Of course, configurations using thisSynchronizer
implementation are not thread-safe!Implementation note: This class is an enumeration because only a single instance needs to exist. This instance can be shared between arbitrary configurations.
- Since:
- 2.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INSTANCE
The single shared instance of this class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginRead()
Notifies thisSynchronizer
that the current thread is going to start a read operation on the managed configuration.void
beginWrite()
Notifies thisSynchronizer
that the current thread is going to start a write operation on the managed configuration.void
endRead()
Notifies thisSynchronizer
that the current thread has finished its read operation.void
endWrite()
Notifies thisSynchronizer
that the current thread has finished its write operation.static NoOpSynchronizer
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static NoOpSynchronizer[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INSTANCE
public static final NoOpSynchronizer INSTANCE
The single shared instance of this class.
-
-
Method Detail
-
values
public static NoOpSynchronizer[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NoOpSynchronizer c : NoOpSynchronizer.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NoOpSynchronizer valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
beginRead
public void beginRead()
Description copied from interface:Synchronizer
Notifies thisSynchronizer
that the current thread is going to start a read operation on the managed configuration. This call can block if a concrete implementation decides that the thread has to wait until a specific condition is fulfilled.- Specified by:
beginRead
in interfaceSynchronizer
-
beginWrite
public void beginWrite()
Description copied from interface:Synchronizer
Notifies thisSynchronizer
that the current thread is going to start a write operation on the managed configuration. This call may block. For instance, a concrete implementation may suspend the thread until all read operations currently active are finished,- Specified by:
beginWrite
in interfaceSynchronizer
-
endRead
public void endRead()
Description copied from interface:Synchronizer
Notifies thisSynchronizer
that the current thread has finished its read operation. This may cause other waiting threads to be granted access to the managed configuration.- Specified by:
endRead
in interfaceSynchronizer
-
endWrite
public void endWrite()
Description copied from interface:Synchronizer
Notifies thisSynchronizer
that the current thread has finished its write operation. This may cause other waiting threads to be granted access to the managed configuration.- Specified by:
endWrite
in interfaceSynchronizer
-
-