Package org.goplanit.gtfs.util

Class GtfsFileConditions

java.lang.Object

org.goplanit.gtfs.util.GtfsFileConditions

public class GtfsFileConditions
extends Object

Class indicating conditions regarding the presence of the GTFS file type

Author:

markr

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GtfsFileConditions(GtfsFileTypePresence presenceCondition, GtfsFileType requiredWhenAbsent, GtfsFileType requiredWhenPresent)	Constructor

Method Summary

Modifier and Type	Method	Description
GtfsFileType	getOtherFileDependency()	Collect the dependency on other file type's presence/or not.
boolean	isConditionallyRequired()	Verify if conditionally required
boolean	isOptional()	Verify if optional
boolean	isRequired()	Verify if required
boolean	isRequiredWhenOtherFileAbsent()	Check if conditional requirement depends on other file being absent
boolean	isRequiredWhenOtherFilePresent()	Check if conditional requirement depends on other file being present
static GtfsFileConditions	optional()	Create a file condition indicating it is optional
static GtfsFileConditions	required()	Create a file condition indicating it is required
static GtfsFileConditions	requiredInAbsenceOf(GtfsFileType otherFileType)	Create a file condition indicating it is required if another file is not present
static GtfsFileConditions	requiredInPresenceOf(GtfsFileType otherFileType)	Create a file condition indicating it is required if another file is present

Methods inherited from class java.lang.Object

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

Constructor Detail

GtfsFileConditions

protected GtfsFileConditions(GtfsFileTypePresence presenceCondition,
                             GtfsFileType requiredWhenAbsent,
                             GtfsFileType requiredWhenPresent)

Constructor

Parameters:

presenceCondition - to use

requiredWhenAbsent - to use

requiredWhenPresent - to use

Method Detail

required

public static GtfsFileConditions required()

Create a file condition indicating it is required

Returns:

created file condition

optional

public static GtfsFileConditions optional()

Create a file condition indicating it is optional

Returns:

created file condition

requiredInPresenceOf

public static GtfsFileConditions requiredInPresenceOf(GtfsFileType otherFileType)

Create a file condition indicating it is required if another file is present

Parameters:

otherFileType - when present this is also required to be present

Returns:

created file condition

requiredInAbsenceOf

public static GtfsFileConditions requiredInAbsenceOf(GtfsFileType otherFileType)

Create a file condition indicating it is required if another file is not present

Parameters:

otherFileType - when not present this is required to be present

Returns:

created file condition

isRequired

public boolean isRequired()

Verify if required

Returns:

true when required false otherwise

isConditionallyRequired

public boolean isConditionallyRequired()

Verify if conditionally required

Returns:

true when conditionally required false otherwise

isOptional

public boolean isOptional()

Verify if optional

Returns:

true when optional false otherwise

getOtherFileDependency

public GtfsFileType getOtherFileDependency()

Collect the dependency on other file type's presence/or not. Only relevant when conditionally required

Returns:

other file type

isRequiredWhenOtherFilePresent

public boolean isRequiredWhenOtherFilePresent()

Check if conditional requirement depends on other file being present

Returns:

true when dependent on other file presence and conditionally required (or required)

isRequiredWhenOtherFileAbsent

public boolean isRequiredWhenOtherFileAbsent()

Check if conditional requirement depends on other file being absent

Returns:

true when dependent on other file absence and conditionally required (or required)