XClassCreator.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.celements.common.classes;

import org.xwiki.component.annotation.ComponentRole;

import com.celements.model.classes.ClassDefinition;
import com.celements.model.classes.ClassPackage;

@ComponentRole
public interface XClassCreator {

  /**
   * creates XClasses from all {@link ClassPackage}s if activated, class definition isn't
   * blacklisted and XClasses don't exist. If they do exist, newly added fields are being created.
   */
  public void createXClasses();

  /**
   * creates XClasses from provided classPackage if class definition isn't blacklisted and XClasses
   * don't exist. If they do exist, newly added fields are being created.
   *
   * @param classPackage
   * @throws XClassCreateException
   */
  public void createXClasses(ClassPackage classPackage) throws XClassCreateException;

  /**
   * creates XClass from provided classDefinition if doesn't exist. If it does exist, newly added
   * fields are being created.
   *
   * @param classDefinition
   * @throws XClassCreateException
   */
  public void createXClass(ClassDefinition classDefinition) throws XClassCreateException;

}