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.applib.value.semantics;
  
  import java.io.Serializable;
  import java.time.ZoneId;
  import java.time.ZoneOffset;
  import java.time.temporal.Temporal;
  import java.util.Optional;
  
  import org.jspecify.annotations.Nullable;
  
  import org.apache.causeway.commons.functional.Either;
  
  /**
   * Decomposes arbitrary time representing values of type T into a canonical representation.
   */
  public interface TemporalSupport<T> extends TemporalCharacteristicsProvider {
  
      public record TemporalDecomposition(
              Temporal localTemporal,
              Optional<Either<ZoneId, ZoneOffset>> zoneOrOffset,
              TemporalCharacteristic temporalCharacteristic,
              OffsetCharacteristic offsetCharacteristic
              ) implements Serializable {
      }
  
      /**
       * Decomposes any temporal value into 2 parts, a 'local' {@link Temporal} and a {@link ZoneId}.
       */
      Optional<TemporalDecomposition> decomposeTemporal(final @Nullable T temporal);
  
  }
  