Class File


  • public class File
    extends java.lang.Object
    • 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 MISSING_LICENSE  
    • Constructor Summary

      Constructors 
      Constructor Description
      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 File objects.
    • Field Detail

    • Constructor Detail

      • File

        public 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 File objects. A file object is valid if it has a license or is explicitly marked as being 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

      • 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.time.Instant getEmbargoDate()
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object