/*
    * Metis: Java Data Framework
    * Copyright 2012-2026. Tony Washer
    *
    * 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 io.github.tonywasher.joceanus.metis.viewer;
  
  import io.github.tonywasher.joceanus.oceanus.format.OceanusDataFormatter;
  import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataList;
  import io.github.tonywasher.joceanus.metis.data.MetisDataResource;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldItem;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldSet;
  
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  /**
   * Report-able error list.
   */
  public class MetisViewerErrorList
          implements MetisFieldItem, MetisDataList<MetisViewerExceptionWrapper> {
      /**
       * Local Report fields.
       */
      private static final MetisFieldSet<MetisViewerErrorList> FIELD_DEFS = MetisFieldSet.newFieldSet(MetisViewerErrorList.class);
  
      /*
       * Declare Fields.
       */
      static {
          FIELD_DEFS.declareLocalField(MetisDataResource.LIST_SIZE, MetisViewerErrorList::size);
      }
  
      /**
       * The list.
       */
      private final List<MetisViewerExceptionWrapper> theList;
  
      /**
       * Constructor.
       */
      public MetisViewerErrorList() {
          theList = new ArrayList<>();
      }
  
      @Override
      public MetisFieldSet<MetisViewerErrorList> getDataFieldSet() {
          return FIELD_DEFS;
      }
  
      @Override
      public String formatObject(final OceanusDataFormatter pFormatter) {
          return getDataFieldSet().getName();
      }
  
      /**
       * Add elements.
       *
       * @param pValues the list of values to add
       */
      public void addList(final MetisViewerErrorList pValues) {
          /* Loop through the new values */
          final Iterator<MetisViewerExceptionWrapper> myIterator = pValues.iterator();
          while (myIterator.hasNext()) {
              /* Add the value */
              theList.add(myIterator.next());
          }
      }
  
      @Override
      public List<MetisViewerExceptionWrapper> getUnderlyingList() {
          return theList;
      }
  
      /**
       * Obtain the first error.
       *
       * @return the first error (or null)
       */
      public MetisViewerExceptionWrapper getFirst() {
          return isEmpty()
                  ? null
                  : theList.get(0);
      }
  }