org.rythmengine.internal.RythmEvents Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rythm-engine Show documentation
A strong typed high performance Java Template engine with .Net Razor like syntax
There is a newer version: 1.4.2
/* 
 * Copyright (C) 2013 The Rythm Engine project
 * Gelin Luo 
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.rythmengine.internal;

import org.rythmengine.internal.compiler.TemplateClass;
import org.rythmengine.template.ITemplate;
import org.rythmengine.template.TemplateBase;
import org.rythmengine.utils.F;

/**
 * Built in {@link IEvent event}s
 */
public class RythmEvents implements IEvent {
    /**
     * Right before template parsing started
     */
    public static final
    IEvent ON_PARSE = new RythmEvents(true);

    /**
     * Before start building java source code. A good place to inject implicit
     * imports and render args
     */
    public static final
    IEvent ON_BUILD_JAVA_SOURCE = new RythmEvents(true);

    /**
     * Before close generated java source code class. A good place to inject
     * implicit java source
     */
    public static final
    IEvent ON_CLOSING_JAVA_CLASS = new RythmEvents(true);

    /**
     * Immediately after template get parsed and before final template java
     * source code generated
     */
    public static final
    IEvent PARSED = new RythmEvents(true);

    /**
     * Triggered upon parse exception
     */
    public static final
    IEvent PARSE_FAILED = new RythmEvents(true);

    /**
     * Right before template compilation started
     */
    public static final
    IEvent ON_COMPILE = new RythmEvents(true);

    /**
     * Immediately after template compilation finished and before get cached on disk
     * A good place to do byte code enhancement
     */
    public static final
    IEvent COMPILED = new RythmEvents(true);

    /**
     * Triggered upon compilation of a template class failed
     */
    public static final
    IEvent COMPILE_FAILED = new RythmEvents(true);

    /**
     * Before template render start. A good place to set implicit render args
     */
    public static final
    IEvent ON_RENDER = new RythmEvents(false);

    /**
     * After template rendered.
     */
    public static final
    IEvent RENDERED = new RythmEvents(true);

    /**
     * Before tag invocation
     */
    public static final
    IEvent> ON_TAG_INVOCATION = new RythmEvents>(false);

    /**
     * Triggered immediately when RythmEngine.invokeTemplate() method get called
     */
    public static final
    IEvent ENTER_INVOKE_TEMPLATE = new RythmEvents(false);

    /**
     * Triggered after RythmEngine.invokeTemplate() method get called
     */
    public static final
    IEvent EXIT_INVOKE_TEMPLATE = new RythmEvents(false);

    /**
     * Before tag invocation
     */
    public static final
    IEvent> TAG_INVOKED = new RythmEvents>(false);

    /**
     * Render execution exception captured
     */
    public static final
    IEvent> ON_RENDER_EXCEPTION = new RythmEvents>(true);
    
    private boolean safe = false;
    
    private RythmEvents() {}
    private RythmEvents(boolean isSafe) {
        safe = isSafe;
    }
    
    public boolean isSafe() {
        return safe;
    }

    @Override
    public RETURN trigger(IEventDispatcher eventBus, PARAM eventParam) {
        return (RETURN) eventBus.accept(this, eventParam);
    }
}