org.fuin.srcgen4j.commons.InitializableElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of srcgen4j-commons Show documentation

Source code generation for Java (Commons)

The newest version!

/**
 * Copyright (C) 2015 Michael Schnell. All rights reserved. 
 * http://www.fuin.org/
 *
 * This library 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 3 of the License, or (at your option) any
 * later version.
 *
 * This library 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 library. If not, see http://www.gnu.org/licenses/.
 */
package org.fuin.srcgen4j.commons;

import java.util.Map;

import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;

/**
 * Used by elements that require initialization with parent and variables.
 * 
 * @param 
 *            Type of the instance that implements this interface.
 * @param 
 *            Type of the element's parent.
 */
public interface InitializableElement {

    /**
     * Initializes this object and it's childs.
     * 
     * @param context
     *            Current context.
     * @param parent
     *            Parent.
     * @param vars
     *            Variables to use.
     * 
     * @return This instance.
     */
    @NotNull
    public ELEMENT init(@NotNull SrcGen4JContext context, @NotNull PARENT parent, @Nullable Map vars);

}