com.hcl.domino.richtext.structures.ObjectDescriptor 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.util.Optional;

import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.NotesConstants;
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;

/**
 * @author Jesse Gallagher
 * @since 1.0.38
 */
@StructureDefinition(
  name = "OBJECT_DESCRIPTOR",
  members = {
    @StructureMember(name = "ObjectType", type = ObjectDescriptor.ObjectType.class),
    @StructureMember(name = "RRV", type = int.class)
  }
)
public interface ObjectDescriptor extends ResizableMemoryStructure {
  enum ObjectType implements INumberEnum {
    FILE(NotesConstants.OBJECT_FILE),
    FILTER_LEFTTODO(NotesConstants.OBJECT_FILTER_LEFTTODO),
    ASSIST_RUNDATA(NotesConstants.OBJECT_ASSIST_RUNDATA),
    UNKNOWN(NotesConstants.OBJECT_UNKNOWN);
    private final short value;
    
    private ObjectType(short value) {
      this.value = value;
    }

    @Override
    public long getLongValue() {
      return value;
    }

    @Override
    public Short getValue() {
      return value;
    }
  }
  
  @StructureGetter("ObjectType")
  Optional getObjectType();
  
  /**
   * Retrieves the object type as a raw {@code short}
   * 
   * @return the object type as a {@code short}
   * @since 1.24.0
   */
  @StructureGetter("ObjectType")
  short getObjectTypeRaw();
  
  @StructureSetter("ObjectType")
  ObjectDescriptor setObjectType(ObjectType objectType);
  
  /**
   * Sets the object type as a raw {@code short}
   * 
   * @param objectType the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("ObjectType")
  ObjectDescriptor setObjectTypeRaw(short objectType);
  
  @StructureGetter("RRV")
  int getRRV();
  
  @StructureSetter("RRV")
  ObjectDescriptor setRRV(int rrv);
}