com.mindoo.domino.jna.constants.CopyDatabase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jna Show documentation
Java project to access the HCL Domino C API using Java Native Access (JNA)
There is a newer version: 0.9.53
package com.mindoo.domino.jna.constants;

import java.util.EnumSet;
import java.util.Set;

import com.mindoo.domino.jna.NotesDatabase;
import com.mindoo.domino.jna.internal.NotesConstants;

/**
 * Option flags for NSFDbCopyExtended and
 * and {@link NotesDatabase#createAndCopyDatabase(String, String, String, String, EnumSet, long, Set, com.mindoo.domino.jna.NotesNamesList)}.
 * 
 * @author Karsten Lehmann
 */
public enum CopyDatabase {

	/**  New database is a replica of the original. */
	REPLICA(NotesConstants.DBCOPY_REPLICA),
	
//	/** Copy template notes. Only supported for NSFDbCopyExtended. */
//	SUBCLASS_TEMPLATE(NotesConstants.DBCOPY_SUBCLASS_TEMPLATE),
	
//	/**  Copy secondary header (such as database quota information).

//	 * This flag may only be used with a local database; using this flag with a remote database
//	 * will return the error ERR_NOT_LOCAL. Only supported for NSFDbCopyExtended. */
//	DBINFO2(NotesConstants.DBCOPY_DBINFO2),
	
//	/**  Copy mail router objects. This flag may only be used with a local database; using this
//	 * flag with a remote database will return the error ERR_NOT_LOCAL. Only supported for NSFDbCopyExtended. */
//	SPECIAL_OBJECTS(NotesConstants.DBCOPY_SPECIAL_OBJECTS),
	
//	/**  Do not copy access control list. Only supported for NSFDbCopyExtended. */
//	NO_ACL(NotesConstants.DBCOPY_NO_ACL),
	
//	/** Do not copy full text index. Only supported for NSFDbCopyExtended. */
//	NO_FULLTEXT(NotesConstants.DBCOPY_NO_FULLTEXT),
	
	/** Use simple encryption in new database. */
	ENCRYPT_SIMPLE(NotesConstants.DBCOPY_ENCRYPT_SIMPLE),
	
	/**  Use middle level of encryption in new database. */
	ENCRYPT_MEDIUM(NotesConstants.DBCOPY_ENCRYPT_MEDIUM),
	
	/**  Use strongest level of encryption in new database. */
	ENCRYPT_STRONG(NotesConstants.DBCOPY_ENCRYPT_STRONG),
	
//	/** Do not update each note's modification time. Only supported for NSFDbCopyExtended. */
//	KEEP_NOTE_MODTIME(NotesConstants.DBCOPY_KEEP_NOTE_MODTIME),
	
	/** Copy the NameList (applicable only when DBCOPY_REPLICA is specified) */
	REPLICA_NAMELIST(NotesConstants.DBCOPY_REPLICA_NAMELIST),

	/** Destination should override default if able to */
	OVERRIDE_DEST(NotesConstants.DBCOPY_OVERRIDE_DEST),
	
	/** Create Db using the latest ODS, regardless of INI settings */
	DBCLASS_HIGHEST_NOTEFILE(NotesConstants.DBCOPY_DBCLASS_HIGHEST_NOTEFILE),
	
	/** Create Db for copy style compaction */
	COMPACT_REPLICA(NotesConstants.DBCOPY_COMPACT_REPLICA);
	
	private int m_val;
	
	CopyDatabase(int val) {
		m_val = val;
	}
	
	/**
	 * Returns the numeric constant for the db creation flag
	 * 
	 * @return constant
	 */
	public int getValue() {
		return m_val;
	}

	/**
	 * Converts a numeric constant to a db creation flag
	 * 
	 * @param value constant
	 * @return db creation flag
	 */
	public static CopyDatabase toType(int value) {
		for (CopyDatabase currClass : values()) {
			if (value == currClass.getValue())
				return currClass;
		}
		throw new IllegalArgumentException("Unknown constant: "+value);
	}
	
	public static int toBitMask(Set flags) {
		int result = 0;
		if (flags!=null) {
			for (CopyDatabase currFlag : values()) {
				if (flags.contains(currFlag)) {
					result = result | currFlag.getValue();
				}
			}
		}
		
		return result;
	}
}