org.gedcomx.records.HasFields Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gedcomx-model Show documentation

There is a newer version: 3.41.0

/**
 * Copyright Intellectual Reserve, Inc.
 *
 * 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 org.gedcomx.records;

import java.util.List;
import java.util.stream.Stream;

/**
 * Interface indicating that a class as a list of record Fields.
 * The list of fields is either directly used as evidence for a value or entity, or is otherwise viewed as logically
 *   being strongly associated with that value or entity, such that it makes sense to group them within it.
 * @author Randy Wilson
 */
public interface HasFields {

  /**
   * Create a stream of fields being used as evidence.
   *
   * @return a stream of fields being used as evidence.
   */
  default Stream fields() {
    return getFields() == null ? Stream.empty() : getFields().stream();
  }

  /**
   * Get the fields being used as evidence.
   *
   * @return The references to the record fields being used as evidence.
   */
  List getFields();

  /**
   * Set the list of fields being used as evidence.
   *
   * @param fields - List of fields
   */
  void setFields(List fields);
}