org.apache.cassandra.db.rows.Unfiltered Maven / Gradle / Ivy
/*
* 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.cassandra.db.rows;
import java.nio.ByteBuffer;
import java.security.MessageDigest;
import java.util.Set;
import org.apache.cassandra.config.CFMetaData;
import org.apache.cassandra.db.Clusterable;
/**
* Unfiltered is the common class for the main constituent of an unfiltered partition.
*
* In practice, an Unfiltered is either a row or a range tombstone marker. Unfiltereds
* are uniquely identified by their clustering information and can be sorted according
* to those.
*/
public interface Unfiltered extends Clusterable
{
public enum Kind { ROW, RANGE_TOMBSTONE_MARKER };
/**
* The kind of the atom: either row or range tombstone marker.
*/
public Kind kind();
/**
* Digest the atom using the provided {@code MessageDigest}.
*
* @param digest the {@code MessageDigest} to use.
*/
public void digest(MessageDigest digest);
/**
* Digest the atom using the provided {@code MessageDigest}.
* This method only exists in 3.11.
* Same like {@link #digest(MessageDigest)}, but excludes the given columns from digest calculation.
*/
public default void digest(MessageDigest digest, Set columnsToExclude)
{
throw new UnsupportedOperationException("no no no - don't use this one - use digest(MessageDigest) instead");
}
/**
* Validate the data of this atom.
*
* @param metadata the metadata for the table this atom is part of.
* @throws org.apache.cassandra.serializers.MarshalException if some of the data in this atom is
* invalid (some value is invalid for its column type, or some field
* is nonsensical).
*/
public void validateData(CFMetaData metadata);
public boolean isEmpty();
public String toString(CFMetaData metadata);
public String toString(CFMetaData metadata, boolean fullDetails);
public String toString(CFMetaData metadata, boolean includeClusterKeys, boolean fullDetails);
default boolean isRow()
{
return kind() == Kind.ROW;
}
default boolean isRangeTombstoneMarker()
{
return kind() == Kind.RANGE_TOMBSTONE_MARKER;
}
}