Class Constants


  • public final class Constants
    extends java.lang.Object
    This class is used for global constants only.

    If your constant is only to be used in a single package, put it in a Constants-class in that package, and make sure it is package private (no modifiers).

    If your constant is used in a single class only, put it in that class, and make sure it is private.

    Remember everything placed here MUST be constants.

    This class is never instantiated, so thread security is not an issue.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ALL_PATTERN
      Pattern that matches everything.
      static java.lang.String ARCDIRECTORY_NAME
      The directory name of the heritrix directory with arcfiles.
      static java.lang.String CDX_MIME_PATTERN
      Pattern that matches our our CDX mimetype.
      static java.lang.String CDX_MIME_TYPE
      The mimetype for a list of CDX entries.
      static int IO_BUFFER_SIZE
      How big a buffer we use for read()/write() operations on InputStream/ OutputStream.
      static long IO_CHUNK_SIZE
      Read this much data when copying data from a file channel.
      static java.util.regex.Pattern IP_KEY_REGEXP
      A full string matcher for an IP-address.
      static java.lang.String IP_REGEX_STRING
      The pattern for an IP-address key.
      static java.util.regex.Pattern IPv6_KEY_REGEXP
      A full string matcher for an IPv6-address.
      static org.apache.lucene.util.Version LUCENE_VERSION
      Lucene version used by this release of NetarchiveSuite.
      static long ONE_DAY_IN_MILLIES
      One day in milliseconds.
      static long ONE_MIN_IN_MILLIES
      One minute in milliseconds.
      static java.lang.String PROJECT_WEBSITE
      The current website for the NetarchiveSuite project.
      static java.lang.String TRANSLATIONS_BUNDLE
      Internationalisation resource bundle for common module.
      static java.lang.String WARCDIRECTORY_NAME
      The directory name of the heritrix directory with warcfiles.
      static java.lang.String XML_EXTENSION
      Extension of XML file names.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getHeritrix3VersionString()  
      static java.lang.String getHeritrixVersionString()
      Get the Heritrix version presently in use.
      static java.text.SimpleDateFormat getIsoDateFormatter()
      Get a formatter that can read and write a date in ISO format including hours/minutes/seconds and timezone.
      static java.lang.String getVersionString​(boolean isHtmlFormat)
      Get a human-readable version string.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getVersionString

        public static java.lang.String getVersionString​(boolean isHtmlFormat)
        Get a human-readable version string.
        Parameters:
        isHtmlFormat - if true, return a html format for the human-readable version string.
        Returns:
        A string telling current version and status of code.
      • getHeritrixVersionString

        public static java.lang.String getHeritrixVersionString()
        Get the Heritrix version presently in use.
        Returns:
        the Heritrix version presently in use
      • getIsoDateFormatter

        public static java.text.SimpleDateFormat getIsoDateFormatter()
        Get a formatter that can read and write a date in ISO format including hours/minutes/seconds and timezone.
        Returns:
        The formatter.