com.hcl.domino.richtext.structures.MemoryStructureWrapperService 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;

import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.JNXServiceFinder;

/**
 * This interface represents a service capable of wrapping {@link ByteBuffer}s
 * into
 * {@link MemoryStructure} instances in an implementation-specific way.
 *
 * @author Jesse Gallagher
 * @since 1.0.15
 */
public interface MemoryStructureWrapperService {
  static MemoryStructureWrapperService get() {
    return JNXServiceFinder.findRequiredService(MemoryStructureWrapperService.class,
        MemoryStructureWrapperService.class.getClassLoader());
  }

  /**
   * Wraps the provided {@link ByteBuffer} into an instance of the provided
   * structure class, without appending
   * it to the destination rich-text entity. This is useful in specific situations
   * where variable data consists
   * of structured values.
   *
   * @param             the type of structure contained in the data
   * @param structureClass a {@link Class} representing {@code }
   * @param data           the data to wrap
   * @return the newly-wrapped structure
   */
   T wrapStructure(Class structureClass, ByteBuffer data);
  
  /**
   * Generates a new proxy object backed by a newly-allocated memory
   * {@link ByteBuffer}.
   * 
   * @param                 the {@link MemoryStructure} sub-interface to proxy
   * @param subtype            a class representing {@code I}
   * @param variableDataLength the amount of additional space, in bytes, to
   *                           allocate after the structure
   * @return a new proxy object
   */
   I newStructure(final Class subtype, final int variableDataLength);

  /**
   * Retrieves the expected size of the provided number or enum type in the
   * C-side structure.
   * 
   * @param type the number or {@link INumberEnum} type
   * @return the size in bytes of the type
   */
  int sizeOf(Class type);

}