com.cedarsoft.couchdb.Row Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.couchdb;


import javax.annotation.Nonnull;
import javax.annotation.Nullable;


/**
 * Represents a row within the result of a query
 *
 * @param  the type of the key
 * @param  the type of the value
 * @param  the type of the document (if there is one)
 */
public class Row {
  @Nullable
  private final DocId id;
  @Nonnull
  private final K key;
  @Nullable
  private final V value;

  @Nullable
  private final CouchDoc doc;

  /**
   * Creates a new row
   * @param id the id
   * @param key the key
   * @param value the value
   */
  public Row( @Nonnull DocId id, @Nonnull K key, @Nullable V value ) {
    this( id, key, value, null );
  }

  /**
   * Creates a new row
   * @param key the key
   * @param value the value
   * @param doc the document
   */
  public Row(  @Nonnull K key, @Nullable V value, @Nullable CouchDoc doc ) {
    this( null, key, value, doc );
  }

  public Row( @Nullable  DocId id, @Nonnull K key, @Nullable V value, @Nullable CouchDoc doc ) {
    this.id = id;
    this.key = key;
    this.value = value;
    this.doc = doc;
  }

  /**
   * Returns a doc id if there is one. Reduced rows do not have a doc id
   * @return the doc id
   */
  @Nullable
  public DocId getId() {
    return id;
  }

  /**
   * Returns the key for the row
   * @return the key
   */
  @Nonnull
  public K getKey() {
    return key;
  }

  /**
   * Returns the value (if there is one)
   * @return the value
   */
  @Nullable
  public V getValue() {
    return value;
  }

  /**
   * Returns the document
   * @return the document
   */
  @Nullable
  public CouchDoc getDoc() {
    return doc;
  }

  @Override
  public boolean equals( Object obj ) {
    if ( this == obj ) {
      return true;
    }
    if ( !( obj instanceof Row ) ) {
      return false;
    }

    Row row = ( Row ) obj;

    if ( doc != null ? !doc.equals( row.doc ) : row.doc != null ) {
      return false;
    }
    if ( id != null ? !id.equals( row.id ) : row.id != null ) {
      return false;
    }
    if ( !key.equals( row.key ) ) {
      return false;
    }
    if ( value != null ? !value.equals( row.value ) : row.value != null ) {
      return false;
    }

    return true;
  }

  @Override
  public int hashCode() {
    int result = id != null ? id.hashCode() : 0;
    result = 31 * result + key.hashCode();
    result = 31 * result + ( value != null ? value.hashCode() : 0 );
    result = 31 * result + ( doc != null ? doc.hashCode() : 0 );
    return result;
  }
}