com.hcl.domino.richtext.structures.CDFace 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.charset.Charset;
import java.text.MessageFormat;

import com.hcl.domino.data.NativeItemCoder;
import com.hcl.domino.data.NativeItemCoder.LmbcsVariant;
import com.hcl.domino.misc.StructureSupport;
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.32
 */
@StructureDefinition(
  name = "CDFACE",
  members = {
    @StructureMember(name = "Face", type = byte.class, unsigned = true),
    @StructureMember(name = "Family", type = byte.class),
    @StructureMember(name = "Name", type=byte[].class, length = RichTextConstants.MAXFACESIZE)
  }
)
public interface CDFace extends MemoryStructure {
  @StructureGetter("Face")
  short getFace();
  
  @StructureSetter("Face")
  CDFace setFace(short face);
  
  @StructureGetter("Name")
  byte[] getNameRaw();
  
  @StructureSetter("Name")
  CDFace setNameRaw(byte[] name);
  
  default String getName() {
    return StructureSupport.readLmbcsValue(getNameRaw());
  }
  
  default CDFace setName(String name) {
   Charset lmbcsNullTerm =  NativeItemCoder.get().getLmbcsCharset(LmbcsVariant.NULLTERM);
   byte[] nameLMBCS = name.getBytes(lmbcsNullTerm);
   if (nameLMBCS.length > RichTextConstants.MAXFACESIZE) {
     throw new IllegalArgumentException(
         MessageFormat.format("Name exceeds max length of {0} byte: {1}",
             RichTextConstants.MAXFACESIZE, name));
   }
   setNameRaw(nameLMBCS);
   return this;
  }
}