SortOrder

java.lang.Object
- org.apache.iceberg.SortOrder

All Implemented Interfaces:

java.io.Serializable
```
public class SortOrder
extends java.lang.Object
implements java.io.Serializable
```
A sort order that defines how data and delete files should be ordered in a table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SortOrder.Builder
A builder used to create valid sort orders.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SortOrder.Builder` A builder used to create valid `sort orders`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SortOrder.Builder`	`builderFor(Schema schema)` Creates a new `sort order builder` for the given `Schema`.
`static void`	`checkCompatibility(SortOrder sortOrder, Schema schema)`
`boolean`	`equals(java.lang.Object other)`
`java.util.List<SortField>`	`fields()` Returns the list of `sort fields` for this sort order
`int`	`hashCode()`
`boolean`	`isSorted()` Returns true if the sort order is sorted
`boolean`	`isUnsorted()` Returns true if the sort order is unsorted
`int`	`orderId()` Returns the ID of this sort order
`boolean`	`sameOrder(SortOrder anotherSortOrder)` Checks whether this order is equivalent to another order while ignoring the order id.
`boolean`	`satisfies(SortOrder anotherSortOrder)` Checks whether this order satisfies another order.
`Schema`	`schema()` Returns the `Schema` for this sort order
`java.lang.String`	`toString()`
`UnboundSortOrder`	`toUnbound()`
`static SortOrder`	`unsorted()` Returns a sort order for unsorted tables.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - schema
```
public Schema schema()
```
    Returns the Schema for this sort order
  - orderId
```
public int orderId()
```
    Returns the ID of this sort order
  - fields
```
public java.util.List<SortField> fields()
```
    Returns the list of sort fields for this sort order
  - isSorted
```
public boolean isSorted()
```
    Returns true if the sort order is sorted
  - isUnsorted
```
public boolean isUnsorted()
```
    Returns true if the sort order is unsorted
  - satisfies
```
public boolean satisfies(SortOrder anotherSortOrder)
```
    Checks whether this order satisfies another order.
    
    Parameters:
    
    anotherSortOrder - a different sort order
    
    Returns:
    
    true if this order satisfies the given order
  - sameOrder
```
public boolean sameOrder(SortOrder anotherSortOrder)
```
    Checks whether this order is equivalent to another order while ignoring the order id.
    
    Parameters:
    
    anotherSortOrder - a different sort order
    
    Returns:
    
    true if this order is equivalent to the given order
  - toUnbound
```
public UnboundSortOrder toUnbound()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - unsorted
```
public static SortOrder unsorted()
```
    Returns a sort order for unsorted tables.
    
    Returns:
    
    an unsorted order
  - builderFor
```
public static SortOrder.Builder builderFor(Schema schema)
```
    Creates a new sort order builder for the given Schema.
    
    Parameters:
    
    schema - a schema
    
    Returns:
    
    a sort order builder for the given schema
  - checkCompatibility
```
public static void checkCompatibility(SortOrder sortOrder,
                                      Schema schema)
```

Class SortOrder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

schema

orderId

fields

isSorted

isUnsorted

satisfies

sameOrder

toUnbound

toString

equals

hashCode

unsorted

builderFor

checkCompatibility