com.hcl.domino.richtext.structures.TFMT 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.design.format.TimeZoneFormat;
import com.hcl.domino.misc.INumberEnum;
import com.hcl.domino.richtext.RichTextConstants;
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.24
 */
@StructureDefinition(name = "TFMT", members = {
    @StructureMember(name = "Date", type = TFMT.DateFormat.class),
    @StructureMember(name = "Time", type = TFMT.TimeFormat.class),
    @StructureMember(name = "Zone", type = TimeZoneFormat.class),
    @StructureMember(name = "Structure", type = TFMT.TimeStructure.class)
})
public interface TFMT extends MemoryStructure {
  enum DateFormat implements INumberEnum {
    /** year, month, and day */
    FULL(RichTextConstants.TDFMT_FULL),
    /** month and day, year if not this year */
    CPARTIAL(RichTextConstants.TDFMT_CPARTIAL),
    /** month and day */
    PARTIAL(RichTextConstants.TDFMT_PARTIAL),
    /** year and month */
    DPARTIAL(RichTextConstants.TDFMT_DPARTIAL),
    /** year(4digit), month, and day */
    FULL4(RichTextConstants.TDFMT_FULL4),
    /** month and day, year(4digit) if not this year */
    CPARTIAL4(RichTextConstants.TDFMT_CPARTIAL4),
    /** year(4digit) and month */
    DPARTIAL4(RichTextConstants.TDFMT_DPARTIAL4);

    private final byte value;

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

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

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

  enum TimeFormat implements INumberEnum {
    /** hour, minute, and second */
    FULL(RichTextConstants.TTFMT_FULL),
    /** hour and minute */
    PARTIAL(RichTextConstants.TTFMT_PARTIAL),
    /** hour */
    HOUR(RichTextConstants.TTFMT_HOUR);

    private final byte value;

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

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

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

  enum TimeStructure implements INumberEnum {
    /** DATE */
    DATE(RichTextConstants.TSFMT_DATE),
    /** TIME */
    TIME(RichTextConstants.TSFMT_TIME),
    /** DATE TIME */
    DATETIME(RichTextConstants.TSFMT_DATETIME),
    /** DATE TIME or TIME Today or TIME Yesterday */
    CDATETIME(RichTextConstants.TSFMT_CDATETIME),
    /** DATE, Today or Yesterday */
    CDATE(RichTextConstants.TSFMT_CDATE);

    private final byte value;

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

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

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

  @StructureGetter("Date")
  Optional getDateFormat();
  
  @StructureGetter("Date")
  byte getDateFormatRaw();

  @StructureGetter("Time")
  Optional getTimeFormat();
  
  @StructureGetter("Time")
  byte getTimeFormatRaw();

  @StructureGetter("Structure")
  Optional getTimeStructure();
  
  @StructureGetter("Structure")
  byte getTimeStructureRaw();

  @StructureGetter("Zone")
  Optional getZoneFormat();
  
  @StructureGetter("Zone")
  byte getZoneFormatRaw();

  @StructureSetter("Date")
  TFMT setDateFormat(DateFormat format);
  
  @StructureSetter("Date")
  TFMT setDateFormatRaw(byte format);

  @StructureSetter("Time")
  TFMT setTimeFormat(TimeFormat format);
  
  @StructureSetter("Time")
  TFMT setTimeFormatRaw(byte format);

  @StructureSetter("Structure")
  TFMT setTimeStructure(TimeStructure structure);
  
  @StructureSetter("Structure")
  TFMT setTimeStructureRaw(byte structure);

  @StructureSetter("Zone")
  TFMT setZoneFormat(TimeZoneFormat format);
  
  @StructureSetter("Zone")
  TFMT setZoneFormatRaw(byte format);
}