org.duraspace.bagit

Class ProfileFieldRule

java.lang.Object

org.duraspace.bagit.ProfileFieldRule

public class ProfileFieldRule
extends Object

Rules which can be applied to the Bag-Info and Other-Info sections of a Bag Profile. Currently supports the parameters specified in version 1.3.0 of the bagit-profiles specification, in addition to the recommended parameter which is brought in from the Beyond the Repository bagit specification.

Since:

2020-01-20

Author:

mikejritter

Constructor Summary

Constructors

Constructor and Description
ProfileFieldRule(boolean required, boolean repeatable, boolean recommended, String description, Set<String> values) Constructor for a ProfileFieldRule.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
Set<String>	getValues()
boolean	isRecommended()
boolean	isRepeatable()
boolean	isRequired()
String	toString() String representation of a ProfileFieldRule

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileFieldRule

public ProfileFieldRule(boolean required,
                        boolean repeatable,
                        boolean recommended,
                        String description,
                        Set<String> values)

Constructor for a ProfileFieldRule. Takes the 4 possible json fields from a BagIt Profile *-Info field.

Parameters:

required - boolean value stating if this rule is required

repeatable - boolean value allowing a field to be repeated

recommended - boolean value stating if this rule is recommended

description - a text description of this rule

values - a set of string values which a field is allowed to be set to

Method Detail

isRequired

public boolean isRequired()

Returns:

if the field for this rule is required to exist

isRepeatable

public boolean isRepeatable()

Returns:

if the field is allowed to be repeated

isRecommended

public boolean isRecommended()

Returns:

if the field for this rule is recommended to exist

getDescription

public String getDescription()

Returns:

the description of this rule

getValues

public Set<String> getValues()

Returns:

the allowed values for fields matching this rule

toString

public String toString()

String representation of a ProfileFieldRule

Overrides:

toString in class Object

Returns:

the string representation