com.hcl.domino.richtext.structures.ResizableMemoryStructure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation

There is a newer version: 1.44.0

/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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.hcl.domino.richtext.structures;

import java.nio.ByteBuffer;

/**
 * This sub-interface of {@link MemoryStructure} represents a structure that is
 * expected to have resizable variable data.
 *
 * @author Jesse Gallagher
 * @since 1.0.15
 */
public interface ResizableMemoryStructure extends MemoryStructure {
  /**
   * Returns the portion of the data after the defined structure (e.g. the text
   * portion of
   * a {@code CDTEXT} record).
   * 
   * This byte buffer starts at the beginning of the variable data and has a
   * length equal to the
   * variable data length.
   * 
   *
   * @return a {@link ByteBuffer} representing the variable-length data of the
   *         record
   */
  ByteBuffer getVariableData();

  /**
   * Resizes the backing memory to the provided {@code size}.
   *
   * @param size the new size in bytes
   */
  void resize(int size);

  /**
   * Resizes the variable portion of this record to the provided {@code size}.
   *
   * @param size the new size in bytes
   * @since 1.0.15
   */
  void resizeVariableData(int size);
}