com.hcl.domino.design.format.ViewFormatHeader 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.design.format;

import java.util.Optional;
import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.misc.ViewFormatConstants;
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;
import com.hcl.domino.richtext.structures.MemoryStructure;

@StructureDefinition(name = "VIEW_FORMAT_HEADER", members = {
    @StructureMember(name = "Version", type = ViewFormatHeader.Version.class),
    @StructureMember(name = "ViewStyle", type = ViewFormatHeader.ViewStyle.class)
})
public interface ViewFormatHeader extends MemoryStructure {
  enum Version implements INumberEnum {
    VERSION1(ViewFormatConstants.VIEW_FORMAT_VERSION);

    private final byte value;

    Version(final byte value) {
      this.value = value;
    }

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

    @Override
    public Byte getValue() {
      return this.value;
    }
  }

  enum ViewStyle implements INumberEnum {
    TABLE(ViewFormatConstants.VIEW_STYLE_TABLE),
    DAY(ViewFormatConstants.VIEW_STYLE_DAY),
    WEEK(ViewFormatConstants.VIEW_STYLE_WEEK),
    MONTH(ViewFormatConstants.VIEW_STYLE_MONTH);

    private final byte value;

    ViewStyle(final byte value) {
      this.value = value;
    }

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

    @Override
    public Byte getValue() {
      return this.value;
    }
  }

  @StructureGetter("Version")
  Optional getVersion();

  /**
   * Retrieves the version as a raw {@code byte}.
   * 
   * @return the version as a {@code byte}
   * @since 1.24.0
   */
  @StructureGetter("Version")
  byte getVersionRaw();

  @StructureGetter("ViewStyle")
  Optional getViewStyle();

  /**
   * Retrieves the view style as a raw {@code byte}.
   * 
   * @return the view style as a {@code byte}
   * @since 1.24.0
   */
  @StructureGetter("ViewStyle")
  byte getViewStyleRaw();

  @StructureSetter("ViewStyle")
  ViewFormatHeader setStyle(ViewStyle style);

  /**
   * Sets the view style as a raw {@code byte}.
   * 
   * @param style the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("ViewStyle")
  ViewFormatHeader setStyleRaw(byte style);

  @StructureSetter("Version")
  ViewFormatHeader setVersion(Version version);

  /**
   * Sets the version as a raw {@code byte}.
   * 
   * @param version the value to set
   * @return this structure
   * @since 1.24.0
   */
  @StructureSetter("Version")
  ViewFormatHeader setVersionRaw(byte version);
}