SupportsExtensionElements.java

/**
 * 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.rt;

import java.util.List;

/**
 * @author Ryan Heaton
 */
public interface SupportsExtensionElements {

  /**
   * Custom extension elements for a resource.
   *
   * @return Custom extension elements for a resource.
   */
  List<Object> getExtensionElements();

  /**
   * Finds the first extension of a specified type.
   *
   * @param clazz The type.
   * @return The extension, or null if none found.
   */
  @SuppressWarnings ( {"unchecked"} )
  <E> E findExtensionOfType(Class<E> clazz);

  /**
   * Find the extensions of a specified type.
   *
   * @param clazz The type.
   * @return The extensions, possibly empty but not null.
   */
  @SuppressWarnings ( {"unchecked"} )
  <E> List<E> findExtensionsOfType(Class<E> clazz);

  /**
   * Add an extension element.
   *
   * @param element The extension element to add.
   */
  void addExtensionElement(Object element);
}