com.epam.deltix.qsrv.hf.pub.WritableValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of timebase-pub Show documentation
Timebase Public API Library
The newest version!
/*
 * Copyright 2023 EPAM Systems, Inc
 *
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. Licensed 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 com.epam.deltix.qsrv.hf.pub;

import com.epam.deltix.qsrv.hf.pub.codec.UnboundEncoder;
import com.epam.deltix.qsrv.hf.pub.md.RecordClassDescriptor;

/**
 *  Write access to a value.
 */
public interface WritableValue {
    public void                 writeBoolean (boolean value);

    public void                 writeChar (char value);

    public void                 writeInt (int value);

    public void                 writeLong (long value);

    public void                 writeFloat (float value);

    public void                 writeDouble (double value);

    public void                 writeString (CharSequence value);

    /**
     * Set length of the array. It must be called prior to nextWritableElement
     * @param len length of the array
     */
    public void                 setArrayLength (int len);

    /**
     * 
     * Returns a transient (reused by interface implementation) WritableValue object for the next element of the array.
     * 
     * 
     * {@link #setArrayLength} method must be called before this method.

     * Client code must not cache the reference for further usage.

     * Usage sample:
     *  encoder.setArrayLength(10);
     *  for(int i=0; i<10; i++) {
     *      WritableValue v = encoder.nextWritableElement (i);
     *      v.setInt(i);
     *  }
     * 
     * @return reference to WritableValue object
     * @throws java.util.NoSuchElementException when when the next element lays beyond array boundary
     */
    public WritableValue        nextWritableElement ();

    //public UnboundEncoder       getFieldEncoder();

    public UnboundEncoder       getFieldEncoder(RecordClassDescriptor rcd);

    public void                 writeBinary (byte [] data, int offset, int length);

    public void                 writeNull ();
}