com.hcl.domino.richtext.structures.ActiveObjectParam 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 com.hcl.domino.misc.StructureSupport;
import com.hcl.domino.richtext.annotation.StructureDefinition;
import com.hcl.domino.richtext.annotation.StructureGetter;
import com.hcl.domino.richtext.annotation.StructureMember;
import com.hcl.domino.richtext.annotation.StructureSetter;

/**
 * Represents the {@code ACTIVEOBJECTPARAM} structure.
 * 
 * @author Jesse Gallagher
 * @since 1.0.44
 */
@StructureDefinition(
  name = "ACTIVEOBJECTPARAM",
  members = {
    @StructureMember(name = "Length", type = short.class, unsigned = true),
    @StructureMember(name = "FormulaLength", type = short.class, unsigned = true),
    @StructureMember(name = "Reserved", type = short.class)
  }
)
public interface ActiveObjectParam extends ResizableMemoryStructure {
  @StructureGetter("Length")
  int getLength();
  
  @StructureSetter("Length")
  ActiveObjectParam setLength(int len);
  
  @StructureGetter("FormulaLength")
  int getFormulaLength();
  
  @StructureSetter("FormulaLength")
  ActiveObjectParam setFormulaLength(int len);
  
  default String getParam() {
    return StructureSupport.extractStringValue(
      this,
      0,
      getLength()
    );
  }
  
  default ActiveObjectParam setParam(String param) {
    return StructureSupport.writeStringValue(
      this,
      0,
      getLength(),
      param,
      this::setLength
    );
  }
  
  default String getFormula() {
    return StructureSupport.extractCompiledFormula(
      this,
      getLength(),
      getFormulaLength()
    );
  }
  
  default ActiveObjectParam setFormula(String formula) {
    return StructureSupport.writeCompiledFormula(
      this,
      getLength(),
      getFormulaLength(),
      formula,
      this::setFormulaLength
    );
  }
}