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.facets.object.domainobject.editing;
  
  import java.util.Optional;
  
  import org.apache.causeway.applib.annotation.DomainObject;
  import org.apache.causeway.commons.internal.base._Strings;
  import org.apache.causeway.commons.internal.exceptions._Exceptions;
  import org.apache.causeway.core.config.CausewayConfiguration;
  import org.apache.causeway.core.config.metamodel.facets.DomainObjectConfigOptions;
  import org.apache.causeway.core.metamodel.consent.Consent.VetoReason;
  import org.apache.causeway.core.metamodel.facetapi.FacetHolder;
  import org.apache.causeway.core.metamodel.facets.object.immutable.ImmutableFacet;
  import org.apache.causeway.core.metamodel.facets.object.immutable.ImmutableFacetAbstract;
  
  public class ImmutableFacetForDomainObjectAnnotation
  extends ImmutableFacetAbstract {
  
      // -- FACTORY
  
      public static Optional<ImmutableFacet> create(
              final Optional<DomainObject> domainObjectIfAny,
              final CausewayConfiguration configuration,
              final FacetHolder holder) {
  
          final boolean editingDisabledByDefault =
                  configuration.getApplib().getAnnotation().getDomainObject().getEditing()
                  == DomainObjectConfigOptions.EditingObjectsConfiguration.FALSE;
  
          if(domainObjectIfAny.isPresent()) {
              var domainObject = domainObjectIfAny.get();
              var disabledReason = createDisabledReason(domainObject);
  
              switch (domainObject.editing()) {
              case NOT_SPECIFIED:
              case AS_CONFIGURED:
  
                  if(holder.containsNonFallbackFacet(ImmutableFacet.class)) {
                      // do not replace
                      return Optional.empty();
                  }
  
                  return editingDisabledByDefault
                          ? Optional.of(new ImmutableFacetForDomainObjectAnnotationAsConfigured(disabledReason, holder))
                          : Optional.empty();
              case DISABLED:
                  return Optional.of(new ImmutableFacetForDomainObjectAnnotation(disabledReason, holder));
              case ENABLED:
                  return Optional.empty(); // see also EditingEnabledFacetForDomainObjectAnnotation
              default:
                  throw _Exceptions.unmatchedCase(domainObject.editing());
              }
          }
  
          return editingDisabledByDefault
                      ? Optional.of(ImmutableFacetFromConfiguration.create(holder))
                      : Optional.empty();
      }
  
      // -- CONSTRUCTOR
  
      protected ImmutableFacetForDomainObjectAnnotation(
              final VetoReason reason,
              final FacetHolder holder) {
          super(reason, holder);
      }
  
      // -- IMPL
  
      @Override
      public ImmutableFacet clone(final FacetHolder holder) {
          return new ImmutableFacetForDomainObjectAnnotation(reason, holder);
      }
  
      // -- HELPER
  
      /**
       * If a reason is explicitly given via {@link DomainObject} annotation, we use it here,
       * otherwise using a fallback reason.
       */
      private static VetoReason createDisabledReason(final DomainObject domainObject) {
          return _Strings.nonEmpty(domainObject.editingDisabledReason())
                  .map(VetoReason::explicit)
                  // assuming there is no ImmutableFacet(s) with inverted semantics
                  .orElseGet(()->VetoReason.editingObjectDisabledReasonNotGiven());
      }
  
  }
  