org.bedework.calfacade.base.XpropsEntity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bw-calendar-facade Show documentation
Common calendar classes and code for bedework
The newest version!
/* ********************************************************************
    Licensed to Jasig under one or more contributor license
    agreements. See the NOTICE file distributed with this work
    for additional information regarding copyright ownership.
    Jasig licenses this file to you 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.bedework.calfacade.base;

import org.bedework.calfacade.BwXproperty;
import org.bedework.calfacade.annotations.NoDump;
import org.bedework.calfacade.annotations.ical.NoProxy;

import java.util.ArrayList;
import java.util.List;

/** An entity that can have one or more x-properties will implement this interface.
 *
 * @author douglm
 */
public interface XpropsEntity {
  /** Set the x-props
   *
   * @param val    List of x-props
   */
  void setXproperties(List val);

  /**
   * @return List
   */
  List getXproperties();

  /**
   * @return int
   */
  int getNumXproperties();

  /**
   *
   * @param val - name to match
   * @return list of matching properties - never null
   */
  List getXproperties(String val);

  /** Find x-properties storing the value of the named ical property
   *
   * @param val - name to match
   * @return list of matching properties - never null
   */
  List getXicalProperties(String val);

  /** REturn x-properties not skipped
   *
   * @return list of matching properties - never null
   */
  @NoProxy
  @NoDump
  default List getXnonskipProperties() {
    final List res = new ArrayList<>();
    final List xs = getXproperties();
    if (xs == null) {
      return res;
    }

    for (final BwXproperty x: xs) {
      if (x == null) {
        continue;
      }

      if (x.getSkip()) {
        continue;
      }
      res.add(x);
    }

    return res;
  }

  /** Remove all instances of the named property.
   *
   * @param val - name to match
   * @return number of removed proeprties
   */
  int removeXproperties(String val);

  /**
   * @param val an x-prop
   */
  void addXproperty(BwXproperty val);

  /**
   * @param val an x-prop
   */
  void removeXproperty(BwXproperty val);

  /**
   * @return List of x-properties
   */
  List cloneXproperty();
}