Package no.unit.nva.model.associatedartifacts.file

Class File

java.lang.Object

no.unit.nva.model.associatedartifacts.file.File

All Implemented Interfaces:

no.unit.nva.commons.json.JsonSerializable, AssociatedArtifact

Direct Known Subclasses:

AdministrativeAgreement, LegacyFile, PublishedFile, UnpublishedFile

public abstract class File
extends java.lang.Object
implements no.unit.nva.commons.json.JsonSerializable, AssociatedArtifact

An object that represents the description of a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	File.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADMINISTRATIVE_AGREEMENT_FIELD
static java.lang.String	EMBARGO_DATE_FIELD
static java.lang.String	IDENTIFIER_FIELD
static java.lang.String	LICENSE_FIELD
static java.lang.String	MIME_TYPE_FIELD
static java.lang.String	MISSING_LICENSE
static java.lang.String	NAME_FIELD
static java.lang.String	PUBLISHER_AUTHORITY_FIELD
static java.lang.String	SIZE_FIELD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	File(java.util.UUID identifier, java.lang.String name, java.lang.String mimeType, java.lang.Long size, License license, boolean administrativeAgreement, boolean publisherAuthority, java.time.Instant embargoDate)	Constructor for no.unit.nva.file.model.File objects.

Method Summary

Modifier and Type	Method	Description
static File.Builder	builder()
boolean	equals(java.lang.Object o)
boolean	fileDoesNotHaveActiveEmbargo()
java.util.Optional<java.time.Instant>	getEmbargoDate()
java.util.UUID	getIdentifier()
License	getLicense()
java.lang.String	getMimeType()
java.lang.String	getName()
java.lang.Long	getSize()
int	hashCode()
boolean	isAdministrativeAgreement()
boolean	isPublisherAuthority()
abstract boolean	isVisibleForNonOwner()
PublishedFile	toPublishedFile()
java.lang.String	toString()
AdministrativeAgreement	toUnpublishableFile()
UnpublishedFile	toUnpublishedFile()
void	validate()	Validate the file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface no.unit.nva.commons.json.JsonSerializable

toJsonString

Field Detail

IDENTIFIER_FIELD

public static final java.lang.String IDENTIFIER_FIELD

See Also:

Constant Field Values

NAME_FIELD

public static final java.lang.String NAME_FIELD

See Also:

Constant Field Values

MIME_TYPE_FIELD

public static final java.lang.String MIME_TYPE_FIELD

See Also:

Constant Field Values

SIZE_FIELD

public static final java.lang.String SIZE_FIELD

See Also:

Constant Field Values

LICENSE_FIELD

public static final java.lang.String LICENSE_FIELD

See Also:

Constant Field Values

ADMINISTRATIVE_AGREEMENT_FIELD

public static final java.lang.String ADMINISTRATIVE_AGREEMENT_FIELD

See Also:

Constant Field Values

PUBLISHER_AUTHORITY_FIELD

public static final java.lang.String PUBLISHER_AUTHORITY_FIELD

See Also:

Constant Field Values

EMBARGO_DATE_FIELD

public static final java.lang.String EMBARGO_DATE_FIELD

See Also:

Constant Field Values

MISSING_LICENSE

public static final java.lang.String MISSING_LICENSE

See Also:

Constant Field Values

Constructor Detail

File

protected File(java.util.UUID identifier,
               java.lang.String name,
               java.lang.String mimeType,
               java.lang.Long size,
               License license,
               boolean administrativeAgreement,
               boolean publisherAuthority,
               java.time.Instant embargoDate)

Constructor for no.unit.nva.file.model.File objects. A file object is valid if it has a license or is explicitly marked as an administrative agreement.

Parameters:

identifier - A UUID that identifies the file in storage

name - The original name of the file

mimeType - The mimetype of the file

size - The size of the file

license - The license for the file, may be null if and only if the file is an administrative agreement

administrativeAgreement - True if the file is an administrative agreement

publisherAuthority - True if the file owner has publisher authority

embargoDate - The date after which the file may be published

Method Detail

builder

public static File.Builder builder()

validate

public void validate()

Validate the file.

getIdentifier

public java.util.UUID getIdentifier()

getName

public java.lang.String getName()

getMimeType

public java.lang.String getMimeType()

getSize

public java.lang.Long getSize()

getLicense

public License getLicense()

isAdministrativeAgreement

public boolean isAdministrativeAgreement()

isPublisherAuthority

public boolean isPublisherAuthority()

getEmbargoDate

public java.util.Optional<java.time.Instant> getEmbargoDate()

fileDoesNotHaveActiveEmbargo

public boolean fileDoesNotHaveActiveEmbargo()

toUnpublishedFile

public UnpublishedFile toUnpublishedFile()

toPublishedFile

public PublishedFile toPublishedFile()

toUnpublishableFile

public final AdministrativeAgreement toUnpublishableFile()

isVisibleForNonOwner

public abstract boolean isVisibleForNonOwner()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object