com.github.helenusdriver.persistence.Ordering Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - API

The newest version!

/*
 * Copyright (C) 2015-2015 The Helenus Driver Project 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 com.github.helenusdriver.persistence;


/**
 * The Ordering enumeration provides clustering key ordering
 * direction.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Jan 15, 2015 - paouelle - Creation
 *
 * @since 1.0
 */
@SuppressWarnings("javadoc")
public enum Ordering {
  ASCENDING("ASC"),
  DESCENDING("DESC");

  /**
   * Holds the non-null CQL string for the ordering type.
   *
   * @author paouelle
   */
  public final String CQL;

  /**
   * Instantiates a new Ordering object.
   *
   * @author paouelle
   *
   * @param cql the non-null CQL string for the ordering type
   */
  private Ordering(String cql) {
    this.CQL = cql;
  }
}