org.apache.phoenix.schema.ColumnValueDecoder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of phoenix-core

Core Phoenix codebase

There is a newer version: 5.2.0

/*
 * 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.phoenix.schema;

import org.apache.hadoop.hbase.io.ImmutableBytesWritable;

/**
 * Interface to decode column values that are stored in a byte[] 
 */
public interface ColumnValueDecoder {
    /**
     * sets the ptr to the column value at the given index  
     * @return false if the column value is absent (used to support DEFAULT expressions) or else true 
     */
    boolean decode(ImmutableBytesWritable ptr, int index);
}