CqlRowMetadata.java

/*
 * 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.cyclop.model;

import java.io.Serializable;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;

import net.jcip.annotations.Immutable;

import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;

/** @author Maciej Miklas */
@Immutable
public final class CqlRowMetadata implements Serializable {

	public final static CqlRowMetadata EMPTY = new CqlRowMetadata();

	/** all columns returned by db query in exact the same order */
	@NotNull
	@Valid
	public final ImmutableList<CqlExtendedColumnName> columns;

	/**
	 * could be null, it not found in result, or in case of error while reading
	 * meta data info
	 */
	public final transient CqlPartitionKey partitionKey;

	public CqlRowMetadata(ImmutableList<CqlExtendedColumnName> columns, CqlPartitionKey partitionKey) {
		this.columns = columns;
		this.partitionKey = partitionKey;
	}

	private CqlRowMetadata() {
		this.columns = ImmutableList.of();
		this.partitionKey = null;
	}

	@Override
	public String toString() {
		return MoreObjects.toStringHelper(this).add("columns", columns).add("partitionKey", partitionKey).toString();
	}

	@Override
	public boolean equals(Object obj) {
		if (obj == null || getClass() != obj.getClass()) {
			return false;
		}
		CqlRowMetadata cqlObj = (CqlRowMetadata) obj;
		return java.util.Objects.equals(columns, cqlObj.columns)
				&& java.util.Objects.equals(partitionKey, cqlObj.partitionKey);
	}

	@Override
	public int hashCode() {
		return java.util.Objects.hash(columns, partitionKey);
	}
}