001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.schemagen;
028
029import gov.nist.secauto.metaschema.core.model.IFlagInstance;
030import gov.nist.secauto.metaschema.core.util.ObjectUtils;
031
032import java.util.Collection;
033import java.util.function.Predicate;
034import java.util.stream.Collectors;
035
036import edu.umd.cs.findbugs.annotations.NonNull;
037
038public final class FlagInstanceFilter {
039  private FlagInstanceFilter() {
040    // disable construction
041  }
042
043  @NonNull
044  public static Collection<? extends IFlagInstance> filterFlags(
045      @NonNull Collection<? extends IFlagInstance> flags,
046      IFlagInstance jsonKeyFlag) {
047    Predicate<IFlagInstance> filter = null;
048
049    // determine if we need to filter a JSON key
050    if (jsonKeyFlag != null) {
051      filter = filterFlag(jsonKeyFlag);
052    }
053    return applyFilter(flags, filter);
054  }
055
056  @NonNull
057  public static Collection<? extends IFlagInstance> filterFlags(
058      @NonNull Collection<? extends IFlagInstance> flags,
059      IFlagInstance jsonKeyFlag,
060      IFlagInstance jsonValueKeyFlag) {
061    Predicate<IFlagInstance> filter = null;
062
063    // determine if we need to filter a JSON key
064    if (jsonKeyFlag != null) {
065      filter = filterFlag(jsonKeyFlag);
066    }
067
068    // determine if we need to filter a JSON value key
069    if (jsonValueKeyFlag != null) {
070      Predicate<IFlagInstance> jsonValueKeyFilter
071          = filterFlag(jsonValueKeyFlag);
072      if (filter == null) {
073        filter = jsonValueKeyFilter;
074      } else {
075        filter = filter.and(jsonValueKeyFilter);
076      }
077    }
078
079    return applyFilter(flags, filter);
080  }
081
082  @NonNull
083  private static Predicate<IFlagInstance>
084      filterFlag(@NonNull IFlagInstance flagToFilter) {
085    return flag -> flag != flagToFilter;
086  }
087
088  @NonNull
089  private static Collection<? extends IFlagInstance> applyFilter(
090      @NonNull Collection<? extends IFlagInstance> flags,
091      Predicate<IFlagInstance> filter) {
092    Collection<? extends IFlagInstance> retval;
093    if (filter == null) {
094      retval = flags;
095    } else {
096      retval = ObjectUtils.notNull(flags.stream()
097          .filter(filter)
098          .collect(Collectors.toList()));
099    }
100    return retval;
101  }
102}