Package org.apache.torque.sql

# Klasse OrderBy

java.lang.Object
org.apache.torque.sql.OrderBy

Alle implementierten Schnittstellen:
  `Serializable`

public class OrderBy extends Object implements Serializable
An order by clause.

Version:
  $Id: OrderBy.java 1917245 2024-04-21 14:06:23Z tv $
Siehe auch:
  - Serialisierte Form

- ## Konstruktorübersicht

  Konstruktoren
  Konstruktor
  Beschreibung
  `OrderBy(Column column, SqlEnum order, boolean ignoreCase)`
  Constructor.

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `boolean`
  `equals(Object obj)`
  Checks whether two orderBy are equal.
  `Column`
  `getColumn()`
  Returns the column to order by.
  `SqlEnum`
  `getOrder()`
  Returns the order to order by (ASC or DESC).
  `int`
  `hashCode()`
  `boolean`
  `isIgnoreCase()`
  Returns whether case should be ignored for String columns.

  ### Von Klasse geerbte Methoden java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- ## Konstruktordetails

  - ### OrderBy

    public OrderBy(Column column, SqlEnum order, boolean ignoreCase)
    Constructor.
    Parameter:
      `column` - the column to order by, not null.
      `order` - the order, either SqlEnum.DESC or SqlEnum.ASC, not null.
      `ignoreCase` - whether case should be ignored for String columns
    Löst aus:
      `NullPointerException` - if null is passed.
      `IllegalArgumentException` - if an unknown order is passed.

- ## Methodendetails

  - ### getColumn

    public Column getColumn()
    Returns the column to order by.
    Gibt zurück:
      the column to order by, not null.

  - ### getOrder

    public SqlEnum getOrder()
    Returns the order to order by (ASC or DESC).
    Gibt zurück:
      the order, either SqlEnum.DESC or SqlEnum.ASC, not null.

  - ### isIgnoreCase

    public boolean isIgnoreCase()
    Returns whether case should be ignored for String columns.
    Gibt zurück:
      true if case should be ignored for String columns, false otherwise.

  - ### hashCode

    public int hashCode()
    Setzt außer Kraft:
      `hashCode` in Klasse `Object`

  - ### equals

    public boolean equals(Object obj)
    Checks whether two orderBy are equal. This is true if and only if the orders are equal and if the contained columns have the same schema name, table name, column name and sql expression.
    Setzt außer Kraft:
      `equals` in Klasse `Object`
    Parameter:
      `obj` - the object to compare to.
    Gibt zurück:
      true if this object is equal to obj, false otherwise.