com.jcabi.github.mock

Class MkStorage.InFile

java.lang.Object

com.jcabi.github.mock.MkStorage.InFile

All Implemented Interfaces:

MkStorage

Enclosing interface:

MkStorage

@Immutable
@Loggable(value=1)
public static final class MkStorage.InFile
extends Object
implements MkStorage

In file.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.mock.MkStorage

MkStorage.InFile, MkStorage.Synced

Constructor Summary

Constructors

Constructor and Description
MkStorage.InFile() Public ctor.
MkStorage.InFile(File file) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(Iterable<org.xembly.Directive> dirs) Update XML with this directives.
void	lock() Locks storage to the current thread.
String	toString()
void	unlock() Unlock storage.
com.jcabi.xml.XML	xml() Get full XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

MkStorage.InFile

public MkStorage.InFile()
                 throws IOException

Public ctor.

Throws:

IOException - If there is any I/O problem

MkStorage.InFile

public MkStorage.InFile(@NotNull(message="file can\'t be NULL")
                File file)
                 throws IOException

Public ctor.

Parameters:

file - File to use

Throws:

IOException - If there is any I/O problem

Method Detail

toString

public String toString()

Overrides:

toString in class Object

xml

@NotNull(message="XML is never NULL")
public com.jcabi.xml.XML xml()
                      throws IOException

Description copied from interface: MkStorage

Get full XML.

Specified by:

xml in interface MkStorage

Returns:

XML

Throws:

IOException - If there is any I/O problem, or if the current storage is locked by another thread.

apply

public void apply(@NotNull(message="dirs cannot be NULL")
         Iterable<org.xembly.Directive> dirs)
           throws IOException

Description copied from interface: MkStorage

Update XML with this directives.

Specified by:

apply in interface MkStorage

Parameters:

dirs - Directives

Throws:

IOException - If there is any I/O problem, or if the current storage is locked by another thread.

lock

public void lock()

Description copied from interface: MkStorage

Locks storage to the current thread.

If the lock is available, grant it to the calling thread and block all operations from other threads. If not available, wait for the holder of the lock to release it with MkStorage.unlock() before any other operations can be performed.

Locking behavior is reentrant, which means a thread can invoke MkStorage.lock() multiple times, where a hold count is maintained.

Specified by:

lock in interface MkStorage

unlock

public void unlock()

Description copied from interface: MkStorage

Unlock storage.

Locking behavior is reentrant, thus if the thread invoked MkStorage.lock() multiple times, the hold count is decremented. If the hold count reaches 0, the lock is released.

If the current thread does not hold the lock, an IllegalMonitorStateException will be thrown.

Specified by:

unlock in interface MkStorage