io.sarl.api.naming.namespace.IFieldAccessValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api.naming Show documentation

Naming Library of the SARL SDK

The newest version!

/**
 * $Id$
 * 
 * SARL is an general-purpose agent programming language.
 * More details on http://www.sarl.io
 * 
 * Copyright (C) 2014-2024 SARL.io, the Original Authors and Main Authors
 * 
 * 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 io.sarl.api.naming.namespace;

import io.sarl.lang.core.annotation.SarlElementType;
import io.sarl.lang.core.annotation.SarlSpecification;
import java.lang.reflect.Field;
import org.eclipse.xtext.xbase.lib.Pure;
import org.eclipse.xtext.xbase.lib.XbaseGenerated;

/**
 * A tool that is able to determine if a field is observable or not.
 * 
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.12
 */
@FunctionalInterface
@SarlSpecification("0.14")
@SarlElementType(11)
@XbaseGenerated
@SuppressWarnings("all")
public interface IFieldAccessValidator {
  /**
   * Check and replies if the access right for the field.
   * 
   * @param fieldOwner the object that contains the given field.
   * @param field the field to test.
   * @return the access right for the given field, never {@code null}.
   */
  @Pure
  FieldAccessRight getFieldAccessRight(final Object fieldOwner, final Field field);
}