Module io.github.ascopes.jct

Package io.github.ascopes.jct.filemanagers.config

Class JctFileManagerConfigurerChain

java.lang.Object

io.github.ascopes.jct.filemanagers.config.JctFileManagerConfigurerChain

@API(since="0.0.1",
     status=STABLE)
public final class JctFileManagerConfigurerChain
extends Object

A chain of configurers to apply to a file manager.

Note that modifications to instances of this class are not threadsafe (e.g. adding new configurers to the chain). Invoking the configurer chain is also not threadsafe by design.

Since:

0.0.1

Author:

Ashley Scopes

Constructor Summary

Constructors

Constructor	Description
JctFileManagerConfigurerChain()	Initialise this chain.

Method Summary

Modifier and Type	Method	Description
JctFileManagerConfigurerChain	addFirst(JctFileManagerConfigurer configurer)	Add a configurer to the start of the chain.
JctFileManagerConfigurerChain	addLast(JctFileManagerConfigurer configurer)	Add a configurer to the end of the chain.
JctFileManager	configure(JctFileManager fileManager)	Apply each configurer to the given file manager in order.
List<JctFileManagerConfigurer>	list()	Get an immutable copy of the list of configurers.

Methods inherited from class java.lang.Object

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

Constructor Details

JctFileManagerConfigurerChain

public JctFileManagerConfigurerChain()

Initialise this chain.

Method Details

addFirst

public JctFileManagerConfigurerChain addFirst(JctFileManagerConfigurer configurer)

Add a configurer to the start of the chain.

Parameters:

configurer - the configurer to add.

Returns:

this chain for further calls.

addLast

public JctFileManagerConfigurerChain addLast(JctFileManagerConfigurer configurer)

Add a configurer to the end of the chain.

Parameters:

configurer - the configurer to add.

Returns:

this chain for further calls.

list

public List<JctFileManagerConfigurer> list()

Get an immutable copy of the list of configurers.

Returns:

the list of configurers.

configure

public JctFileManager configure(JctFileManager fileManager)

Apply each configurer to the given file manager in order.

Parameters:

fileManager - the file manager to configure.

Returns:

the configured file manager to use. This may or may not be the same object as the input parameter, depending on how the configurers manipulate the input object.