/*
 *  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.navchild;

import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.util.Optional;

import org.apache.causeway.commons.functional.Try;
import org.apache.causeway.commons.internal.reflection._GenericResolver.ResolvedMethod;
import org.apache.causeway.core.metamodel.facetapi.Facet;
import org.apache.causeway.core.metamodel.facetapi.FacetHolder;

/**
 * Provides a MethodHandle and its associated Dewey order.
 *
 * @since 3.2
 */
public sealed interface NavigableSubtreeSequenceFacet
extends Facet
permits NavigableSubtreeSequenceFacetRecord {

    String sequence();
    MethodHandle methodHandle();

    // -- FACTORY

    static Optional<NavigableSubtreeSequenceFacet> create(
        /**
         * Informal text, describing the origin of this facet.
         */
        final String origin,
        final Class<?> cls,
        final Optional<ResolvedMethod> resolvedMethod,
        final String sequence,
        final FacetHolder facetHolder) {

        return resolvedMethod
            .map(ResolvedMethod::method)
            .flatMap(method->Try.call(()->MethodHandles
                    .privateLookupIn(cls, MethodHandles.lookup())
                    .unreflect(method))
                .ifFailure(e->e.printStackTrace())
                .getValue()
                .map(mh->new NavigableSubtreeSequenceFacetRecord(sequence, mh, origin, facetHolder)));
    }

}
