Package com.polarion.platform.repository.spi.config

Class AbstractDataHandler<I,O>

java.lang.Object

com.polarion.platform.repository.spi.config.AbstractDataHandler<I,O>

All Implemented Interfaces:

IDataHandler<I,O>

Direct Known Subclasses:

DOMDataHandler, PropertiesDataHandler

public abstract class AbstractDataHandler<I,O>
extends Object
implements IDataHandler<I,O>

An abstract data handler which works with IRepositoryService

Author:

POLARION SOFTWARE

Constructor Summary

Constructors

Constructor	Description
AbstractDataHandler()

Method Summary

Modifier and Type	Method	Description
O	readLocation(ILocation location, IDataHandlerContext context)	Reads the location in the form suitable to be passed to IDataHandler.writeLocation(ILocation, Object, IDataHandlerContext)
O	readLocations(List<ILocation> locations, IDataHandlerContext context)	Read configuration from given locations Merges the hierarchy of configurations into one
void	writeLocation(ILocation location, I data, IDataHandlerContext context)	Writes data to given location.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDataHandler

public AbstractDataHandler()

Method Details

readLocations

@Nullable
public O readLocations(@NotNull
 List<ILocation> locations,
 @NotNull
 IDataHandlerContext context)

Description copied from interface: IDataHandler

Read configuration from given locations Merges the hierarchy of configurations into one

Specified by:

readLocations in interface IDataHandler<I,O>

Parameters:

locations - The config hierarchy. The first location is the most concrete, following elements are more and more generic. The caller ensures, that only relevant configurations are passed in.

Empty locations means, there is no valid file. In such a case either null or default config can be returned.

context - context

Returns:

merged configuration object

readLocation

@Nullable
public O readLocation(@NotNull
 ILocation location,
 @NotNull
 IDataHandlerContext context)

Description copied from interface: IDataHandler

Reads the location in the form suitable to be passed to IDataHandler.writeLocation(ILocation, Object, IDataHandlerContext)

Specified by:

readLocation in interface IDataHandler<I,O>

Parameters:

location - The location, never null.

context - context

Returns:

the data read from the specified location

writeLocation

public void writeLocation(@NotNull
 ILocation location,
 @NotNull
 I data,
 @NotNull
 IDataHandlerContext context)

Description copied from interface: IDataHandler

Writes data to given location.

Specified by:

writeLocation in interface IDataHandler<I,O>

Parameters:

location - The location, never null.

data - Data as created by the user or by IDataHandler.readLocation(ILocation, IDataHandlerContext).

context - context