content: /*
   *  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.apache.causeway.core.metamodel.progmodel;
  
  import java.util.function.Consumer;
  import java.util.stream.Stream;
  
  import org.apache.causeway.core.metamodel.context.HasMetaModelContext;
  import org.apache.causeway.core.metamodel.facets.FacetFactory;
  import org.apache.causeway.core.metamodel.postprocessors.MetaModelPostProcessor;
  import org.apache.causeway.core.metamodel.spec.ObjectSpecification;
  import org.apache.causeway.core.metamodel.specloader.validator.MetaModelValidator;
  import org.apache.causeway.core.metamodel.specloader.validator.MetaModelValidatorAbstract;
  
  import org.jspecify.annotations.NonNull;
  
  public interface ProgrammingModel
  extends HasMetaModelContext {
  
      // -- ENUM TYPES
  
      enum Marker {
          DEPRECATED,
          INCUBATING,
          JDBC,
          JPA,
          JDO
      }
  
      /**
       * Processing order for registered facet factories
       *
       * @apiNote Prefixes are without any semantic meaning, just to make the ordering
       * transparent to the human reader.
       * Order is defined by {@link FacetProcessingOrder#ordinal()}
       *
       */
      enum FacetProcessingOrder {
  
          A1_FALLBACK_DEFAULTS,
          A2_AFTER_FALLBACK_DEFAULTS,
  
          B1_OBJECT_NAMING,
          B2_AFTER_OBJECT_NAMING,
  
          C1_METHOD_REMOVING,
          C2_AFTER_METHOD_REMOVING,
  
          D1_MANDATORY_SUPPORT,
          D2_AFTER_MANDATORY_SUPPORT,
  
          E1_MEMBER_MODELLING,
          E2_AFTER_MEMBER_MODELLING,
  
          F1_LAYOUT,
          F2_AFTER_LAYOUT,
  
          G1_VALUE_TYPES,
          G2_AFTER_VALUE_TYPES,
  
          Z0_BEFORE_FINALLY,
          Z1_FINALLY,
          Z2_AFTER_FINALLY,
      }
  
      /**
       * Processing order for registered meta-model validators
       *
       * @apiNote Prefixes are without any semantic meaning, just to make the ordering
       * transparent to the human reader.
       * Order is defined by {@link ValidationOrder#ordinal()}
       *
       */
      enum ValidationOrder {
  
          A0_BEFORE_BUILTIN,
          A1_BUILTIN,
          A2_AFTER_BUILTIN,
  
      }
  
      /**
       * Processing order for registered meta-model post-processors
       *
       * @apiNote Prefixes are without any semantic meaning, just to make the ordering
       * transparent to the human reader.
       * Order is defined by {@link PostProcessingOrder#ordinal()}
       *
       */
      enum PostProcessingOrder {
  
          A0_BEFORE_BUILTIN,
          A1_BUILTIN,
          A2_AFTER_BUILTIN,
  
      }
  
      interface MixinNamingStrategy {
          String memberId(Class<?> mixinClass);
          String memberFriendlyName(Class<?> mixinClass);
      }
      
      // -- INTERFACE
      
      /**
       * Naming strategy for mixed-in members. 
       */
      MixinNamingStrategy mixinNamingStrategy();
  
      <T extends FacetFactory> void addFactory(
              FacetProcessingOrder order,
              T instance,
              Marker ... markers);
  
      <T extends MetaModelValidator> void addValidator(
              ValidationOrder order,
              T instance,
              Marker ... markers);
  
      <T extends MetaModelPostProcessor> void addPostProcessor(
              PostProcessingOrder order,
              T instance,
              Marker ... markers);
  
      Stream<FacetFactory> streamFactories();
      Stream<MetaModelValidator> streamValidators();
      Stream<MetaModelPostProcessor> streamPostProcessors();
  
      // -- SHORTCUTS
  
      /** shortcut for see {@link #addValidator(ValidationOrder, MetaModelValidator, Marker...)} */
      default void addValidator(
              final @NonNull MetaModelValidator validator,
              final Marker ... markers) {
  
          addValidator(ValidationOrder.A2_AFTER_BUILTIN, validator, markers);
      }
  
      default void addValidatorSkipManagedBeans(
              final @NonNull Consumer<ObjectSpecification> validator,
              final Marker ... markers) {
  
          addValidator(new MetaModelValidatorAbstract(getMetaModelContext(), MetaModelValidator.SKIP_MANAGED_BEANS) {
              @Override
              public void validateObjectEnter(final @NonNull ObjectSpecification spec) {
                  validator.accept(spec);
              }
          });
      }
  
      default void addValidatorSkipAbstract(
              final @NonNull Consumer<ObjectSpecification> validator,
              final Marker ... markers) {
  
          addValidator(new MetaModelValidatorAbstract(getMetaModelContext(), MetaModelValidator.SKIP_ABSTRACT) {
              @Override
              public void validateObjectEnter(final @NonNull ObjectSpecification spec) {
                  validator.accept(spec);
              }
          });
      }
  
  }
  