com.helger.poi.excel.style.ExcelStyleCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-poi Show documentation

Wrapper around Apache POI

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.helger.poi.excel.style;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.apache.poi.ss.usermodel.CellStyle;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.impl.CommonsHashMap;
import com.helger.commons.collection.impl.ICommonsMap;
import com.helger.commons.string.ToStringGenerator;

/**
 * A caching class that maps {@link ExcelStyle} objects to {@link CellStyle}.
 *
 * @author Philip Helger
 */
public class ExcelStyleCache
{
  private final ICommonsMap  m_aMap = new CommonsHashMap <> ();

  public ExcelStyleCache ()
  {}

  @Nonnull
  @ReturnsMutableObject
  public ICommonsMap  map ()
  {
    return m_aMap;
  }

  @Nullable
  public CellStyle getCellStyle (@Nullable final ExcelStyle aExcelStyle)
  {
    return m_aMap.get (aExcelStyle);
  }

  public void addCellStyle (@Nonnull final ExcelStyle aExcelStyle, @Nonnull final CellStyle aCellStyle)
  {
    ValueEnforcer.notNull (aExcelStyle, "ExcelStyle");
    ValueEnforcer.notNull (aCellStyle, "CellStyle");

    m_aMap.put (aExcelStyle, aCellStyle);
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("Map", m_aMap).getToString ();
  }
}