/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.wicket.extensions.markup.html.repeater.util;
import org.apache.wicket.util.io.IClusterable;
import org.apache.wicket.util.lang.Args;
/**
* Represents sorting information of a property
*
* @author Igor Vaynberg ( ivaynberg )
* @param <T>
* the type of the sort property
*/
public class SortParam<T> implements IClusterable
{
private static final long serialVersionUID = 1L;
private final T property;
private final boolean ascending;
/**
* @param property
* sort property
* @param ascending
* <code>true<code> if sort order is ascending, <code>false</code> if sort order is
* descending
*/
public SortParam(final T property, final boolean ascending)
{
Args.notNull(property, "property");
this.property = property;
this.ascending = ascending;
}
/**
* @return sort property
*/
public T getProperty()
{
return property;
}
/**
* check if sort order is ascending
*
* @return <code>true<code> if sort order is ascending, <code>false</code> if sort order is
* descending
*/
public boolean isAscending()
{
return ascending;
}
@Override
public boolean equals(final Object o)
{
if (this == o)
{
return true;
}
if (!(o instanceof SortParam))
{
return false;
}
@SuppressWarnings("unchecked")
SortParam<T> sortParam = (SortParam<T>)o;
return (ascending == sortParam.ascending) && property.equals(sortParam.property);
}
@Override
public int hashCode()
{
int result = property.hashCode();
result = 31 * result + (ascending ? 1 : 0);
return result;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return new StringBuilder().append("[SortParam property=")
.append(getProperty())
.append(" ascending=")
.append(ascending)
.append("]")
.toString();
}
}