001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS.
026 */
027package org.opends.guitools.controlpanel.datamodel;
028
029/**
030 * Class that describes the VLV sort order.
031 */
032public class VLVSortOrder
033{
034  private String attributeName;
035  private boolean isAscending;
036  private int hashCode;
037
038  /**
039   * Constructor of the VLVSortOrder.
040   * @param attributeName the attribute name to be used to sort.
041   * @param isAscending whether the sorting is ascending or descending.
042   */
043  public VLVSortOrder(String attributeName, boolean isAscending)
044  {
045    this.attributeName = attributeName;
046    this.isAscending = isAscending;
047    hashCode = ("vlvsortorder"+attributeName+isAscending).hashCode();
048  }
049
050  /**
051   * Returns the name of the attribute.
052   * @return the name of the attribute.
053   */
054  public String getAttributeName()
055  {
056    return attributeName;
057  }
058
059  /**
060   * Returns whether the sorting is ascending or descending.
061   * @return <CODE>true</CODE> if the sorting is ascending and
062   * <CODE>false</CODE> otherwise.
063   */
064  public boolean isAscending()
065  {
066    return isAscending;
067  }
068
069  /** {@inheritDoc} */
070  public int hashCode()
071  {
072    return hashCode;
073  }
074
075  /** {@inheritDoc} */
076  public boolean equals(Object o)
077  {
078    if (o == this) {
079      return  true;
080    }
081    if (o instanceof VLVSortOrder)
082    {
083      VLVSortOrder sortOrder = (VLVSortOrder)o;
084      return sortOrder.getAttributeName().equalsIgnoreCase(attributeName)
085          && sortOrder.isAscending() == isAscending;
086    }
087    return false;
088  }
089}