org.cp.elements.lang.Orderable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cp.elements.lang;

/**
 * The Orderable interface defines a contract for classes whose objects can be organized in an ordered context, such as
 * an ordered data structure using arrays or Lists.  In general, the order of objects can be applied in many different
 * ways including sort order, prioritization, or to ascertain precedence between Orderable objects of the same type.
 *
 * @author John J. Blum
 * @param  a type parameter indicating the class of the Orderable type.
 * @see java.lang.Comparable
 * @see org.cp.elements.lang.Ordered
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public interface Orderable> {

  /**
   * Gets the value of the order property which indicates the order of this object relative to it's peers.
   *
   * @return a Comparable value of type T indicating this object's order of precedence.
   */
  T getOrder();

}