io.sarl.api.naming.namespace.AnnotationFieldAccessValidator 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 io.sarl.lang.core.annotation.SyntheticMember;
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 based
 * on the annotation {@link Observable}.
 * 
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.12
 */
@SarlSpecification("0.14")
@SarlElementType(10)
@XbaseGenerated
@SuppressWarnings("all")
public class AnnotationFieldAccessValidator implements IFieldAccessValidator {
  @Override
  @Pure
  public FieldAccessRight getFieldAccessRight(final Object fieldOwner, final Field field) {
    final Observable observable = AnnotationFieldAccessValidator.getObservableAnnotation(field);
    if ((observable != null)) {
      boolean _writable = observable.writable();
      if (_writable) {
        return FieldAccessRight.WRITE;
      }
      return FieldAccessRight.READ;
    }
    return FieldAccessRight.NONE;
  }

  @Pure
  private static Observable getObservableAnnotation(final Field field) {
    Observable annon = field.getAnnotation(Observable.class);
    if ((annon != null)) {
      return annon;
    }
    Class container = field.getDeclaringClass();
    while ((container != null)) {
      {
        annon = container.getAnnotation(Observable.class);
        if ((annon != null)) {
          return annon;
        }
        container = container.getEnclosingClass();
      }
    }
    return null;
  }

  @SyntheticMember
  public AnnotationFieldAccessValidator() {
    super();
  }
}