Access.java

/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * 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.jboss.errai.ioc.client.lifecycle.api;

/**
 * An event for when an IOC bean instance has a method or field accessed.
 *
 * @author Max Barkley <mbarkley@redhat.com>
 */
public interface Access<T> extends LifecycleEvent<T> {
  
  /**
   * @return True if a method has been accessed.
   */
  public boolean isMethodAccess();
  
  /**
   * @return True if a field has been accessed.
   */
  public boolean isFieldAccess();
  
  /**
   * This must be set before the event is fired. Defaults to false if not set.
   * 
   * @param isMethodAccessed True if a method has been accessed.
   */
  public void setIsMethodAccess(boolean isMethodAccessed);
  
  /**
   * This must be set before the event is fired. Defaults to false if not set.
   * 
   * @param isFieldAccessed True if a field has been accessed.
   */
  public void setIsFieldAccess(boolean isFieldAccessed);
  
  /**
   * This must be set before the event is fired.
   * 
   * @param methodOrFieldName The name of the field or method that was accessed.
   */
  public void setMethodOrFieldName(String methodOrFieldName);
  
/**
 * @return The name of the field or method that was accessed.
 */
  public String getMethodOrFieldName();

}