org.apache.druid.segment.data.ReadableOffset Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of druid-processing Show documentation

A module that is everything required to understands Druid Segments

There is a newer version: 30.0.1

/*
 * 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.druid.segment.data;

import org.apache.druid.query.monomorphicprocessing.CalledFromHotLoop;
import org.apache.druid.query.monomorphicprocessing.HotLoopCallee;

/**
 * A ReadableOffset is an object that provides an integer offset, ostensibly as an index into an array.
 *
 * See the companion class Offset, for more context on how this could be useful.  A ReadableOffset should be
 * given to classes (e.g. FloatColumnSelector objects) by something which keeps a reference to the base Offset object
 * and increments it.
 *
 * @see org.apache.druid.segment.vector.ReadableVectorOffset, the vectorized version.
 */
public interface ReadableOffset extends HotLoopCallee
{
  @CalledFromHotLoop
  int getOffset();
}