Class TargetConfiguration

java.lang.Object

de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration

public class TargetConfiguration
extends Object

Represents a collection of output files to which the IP addresses shall be written in the same format.

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable String	format	The format for each IP address (each in a separate line) in the output files.
private final @NonNull HashSet<File>	targetFiles	The output files to which the IP addresses shall be written.

Constructor Summary

Constructors

Constructor	Description
TargetConfiguration()

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<String>	getFormat()
@NonNull HashSet<File>	getTargetFiles()
void	setFiles(@NonNull Collection<File> files)	Updates the targetFiles.
void	setFormat(@NonNull String format)	Updates the format.

Methods inherited from class Object

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

Field Details

format

@Nullable
private @Nullable String format

The format for each IP address (each in a separate line) in the output files. Possible values:

• IpListAggregator#DEFAULT_IP_ADDRESS_FORMATTERS
• formats allowed by CustomIpAddressFormatter

targetFiles

@NonNull
private final @NonNull HashSet<File> targetFiles

The output files to which the IP addresses shall be written.

Constructor Details

TargetConfiguration

public TargetConfiguration()

Method Details

getFormat

@Contract(pure=true,
          value="-> new")
@NonNull
public @NonNull Optional<String> getFormat()

Returns:

The format, if any.

getTargetFiles

@Contract(pure=true,
          value="-> new")
@NonNull
public @NonNull HashSet<File> getTargetFiles()

Returns:

A shallow copy of the targetFiles.

setFormat

@Contract(mutates="this")
public void setFormat(@NonNull
 @NonNull String format)

Updates the format.

Parameters:

format - The new value for the format. Must adhere to the description of the format field later when the actual formatter is created.

setFiles

@Contract(mutates="this")
public void setFiles(@NonNull
 @NonNull Collection<File> files)

Updates the targetFiles.

Parameters:

files - The new output files which replace the current ones.