• Home
• com.barchart.util
• barchart-util-enums
• 2.0.16
• source code
• Dict.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.barchart.util.enums.Dict Maven / Gradle / Ivy

/**
 * Copyright (C) 2011-2012 Barchart, Inc. 
 *
 * All rights reserved. Licensed under the OSI BSD License.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package com.barchart.util.enums;

/** type safe ENUM key */
public interface Dict extends EnumJDK {

	/**
	 * @return creation order; can change from one JVM run another; otherwise is
	 *         GUID during JVM run session;
	 */
	int sequence();

	/**
	 * @return relative index inside class (and super class and *); immutable;
	 *         based on ENUM creation order inside inheritance hierarchy; based
	 *         on ENUM order inside each level;
	 * */
	@Override
	int ordinal();

	/**
	 * @return field name; unique inside each inheritance hierarchy
	 **/
	@Override
	String name();

	//

	/**
	 * @return immutable code for external serialization; user provided optional
	 *         parameter; not checked for uniqueness;
	 */
	String code();

	/** @return unique key based on class names space */
	String guid();

	/** equality is based on ordinal */
	@Override
	boolean equals(Object dict);

	/** hash code is based on ordinal */
	@Override
	int hashCode();

}