com.hcl.domino.data

Enum DatabaseClass

java.lang.Object

java.lang.Enum<DatabaseClass>

com.hcl.domino.data.DatabaseClass

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<DatabaseClass>

public enum DatabaseClass
extends Enum<DatabaseClass>
implements INumberEnum<Short>

Represents the class of a database, which affects its storage characteristics and on-disk structure.

Author:

Jesse Gallagher

Enum Constant Summary

Enum Constants

Enum Constant and Description
BY_EXTENSION The type of the database is determined by the filename extension.
DESKTOP A Notes desktop (folders, icons, etc.)
ENCAPSMAILFILE One document database with size up to 5MB.
GIANTNOTEFILE A standard Domino database, with size up to 1 GB.
HUGENOTEFILE A standard Domino database, with size up to 1 GB.
LRGENCAPSMAILFILE Specifically used by alternate mail.
NOTECLIPBOARD A Notes clipboard (used for cutting and pasting)
NOTEFILE A standard Domino database
NSFTESTFILE A test database
OBJSTORE Object store
ONEDOCFILE One document database with size up to 10MB.
TEMPLATEFILE A database that contains every type of note (forms, views, ACL, icon, etc.) except data notes
V10NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 10
V12NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 12
V2NOTEFILE Database was created as a Notes Release 2 database
V3NOTEFILE Database was created as a Notes Release 3 database.
V3ONEDOCFILE One document database with size up to 10MB.
V4NOTEFILE Database was created specifically for Domino and Notes Release 4
V5NOTEFILE Database was created specifically for Domino and Notes Release 5
V6NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 6
V85NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 8.5
V8NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 8
V9NOTEFILE Database was created specifically for Domino and Notes Release Notes/Domino 9

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static DatabaseClass	valueOf(String name) Returns the enum constant of this type with the specified name.
static DatabaseClass[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BY_EXTENSION

public static final DatabaseClass BY_EXTENSION

The type of the database is determined by the filename extension. The extensions and their database classes are .NSX (NSFTESTFILE), .NSF (NOTEFILE), .DSK (DESKTOP), .NCF (NOTECLIPBOARD), .NTF (TEMPLATEFILE), .NSG (GIANTNOTEFILE), .NSH (HUGENOTEFILE), NTD (ONEDOCFILE), NS2 (V2NOTEFILE), NTM (ENCAPSMAILFILE).

NSFTESTFILE

public static final DatabaseClass NSFTESTFILE

A test database

NOTEFILE

public static final DatabaseClass NOTEFILE

A standard Domino database

DESKTOP

public static final DatabaseClass DESKTOP

A Notes desktop (folders, icons, etc.)

NOTECLIPBOARD

public static final DatabaseClass NOTECLIPBOARD

A Notes clipboard (used for cutting and pasting)

TEMPLATEFILE

public static final DatabaseClass TEMPLATEFILE

A database that contains every type of note (forms, views, ACL, icon, etc.) except data notes

GIANTNOTEFILE

public static final DatabaseClass GIANTNOTEFILE

A standard Domino database, with size up to 1 GB. This was used in Notes Release 3 when the size of a previous version of a database had been limited to 200 MB

HUGENOTEFILE

public static final DatabaseClass HUGENOTEFILE

A standard Domino database, with size up to 1 GB. This was used in Notes Release 3 when the size of a previous version of a database had been limited to 300 MB

ONEDOCFILE

public static final DatabaseClass ONEDOCFILE

One document database with size up to 10MB. Specifically used by alternate mail to create an encapsulated database. Components of the document are further limited in size. It is not recommended that you use this database class with NSFDbCreate. If you do, and you get an error when saving the document, you will need to re-create the database using DBCLASS_NOTEFILE

V2NOTEFILE

public static final DatabaseClass V2NOTEFILE

Database was created as a Notes Release 2 database

ENCAPSMAILFILE

public static final DatabaseClass ENCAPSMAILFILE

One document database with size up to 5MB. Specifically used by alternate mail to create an encapsulated database. Components of the document are further limited in size. It is not recommended that you use this database class with NSFDbCreate. If you do, and you get an error when saving the document, you will need to re-create the database using DBCLASS_NOTEFILE

LRGENCAPSMAILFILE

public static final DatabaseClass LRGENCAPSMAILFILE

Specifically used by alternate mail. Not recomended for use with NSFDbCreate

V3NOTEFILE

public static final DatabaseClass V3NOTEFILE

Database was created as a Notes Release 3 database.

OBJSTORE

public static final DatabaseClass OBJSTORE

Object store

V3ONEDOCFILE

public static final DatabaseClass V3ONEDOCFILE

One document database with size up to 10MB. Specifically used by Notes Release 3 alternate mail to create an encapsulated database. Not recomended for use with NSFDbCreate

V4NOTEFILE

public static final DatabaseClass V4NOTEFILE

Database was created specifically for Domino and Notes Release 4

V5NOTEFILE

public static final DatabaseClass V5NOTEFILE

Database was created specifically for Domino and Notes Release 5

V6NOTEFILE

public static final DatabaseClass V6NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 6

V8NOTEFILE

public static final DatabaseClass V8NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 8

V85NOTEFILE

public static final DatabaseClass V85NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 8.5

V9NOTEFILE

public static final DatabaseClass V9NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 9

V10NOTEFILE

public static final DatabaseClass V10NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 10

V12NOTEFILE

public static final DatabaseClass V12NOTEFILE

Database was created specifically for Domino and Notes Release Notes/Domino 12

Method Detail

values

public static DatabaseClass[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DatabaseClass c : DatabaseClass.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DatabaseClass valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long