/*
 * 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.juneau.commons.reflect;

import static java.util.Collections.*;
import static org.apache.juneau.commons.function.Suppliers.*;
import static org.apache.juneau.commons.utils.CollectionUtils.*;
import static org.apache.juneau.commons.utils.Shorts.*;

import java.lang.annotation.*;
import java.net.*;
import java.util.*;
import java.util.function.*;
import java.util.stream.*;

import org.apache.juneau.commons.collections.*;
import org.apache.juneau.commons.utils.*;

/**
 * Lightweight wrapper around a {@link Package} object providing convenient access to package metadata and annotations.
 *
 * <p>
 * This class provides a cached wrapper around Java {@link Package} objects, extending the standard API with
 * convenient methods for accessing package annotations and metadata. Instances are cached and reused for efficiency.
 *
 * <h5 class='section'>Features:</h5>
 * <ul class='spaced-list'>
 *    <li>Cached instances - package info objects are cached and reused
 *    <li>Annotation support - get annotations declared on the package
 *    <li>Convenient access - easy access to package name and metadata
 *    <li>Thread-safe - instances are immutable and safe for concurrent access
 * </ul>
 *
 * <h5 class='section'>Use Cases:</h5>
 * <ul class='spaced-list'>
 *    <li>Accessing package-level annotations
 *    <li>Working with package metadata
 *    <li>Building frameworks that need to analyze package information
 * </ul>
 *
 * <h5 class='section'>Usage:</h5>
 * <p class='bjava'>
 *    <jc>// Get PackageInfo from a class</jc>
 *    PackageInfo <jv>pi</jv> = PackageInfo.<jsm>of</jsm>(MyClass.<jk>class</jk>);
 *
 *    <jc>// Get package name</jc>
 *    String <jv>name</jv> = <jv>pi</jv>.getName();
 *
 *    <jc>// Get annotations</jc>
 *    List&lt;AnnotationInfo&lt;MyAnnotation&gt;&gt; <jv>annotations</jv> =
 *       <jv>pi</jv>.getAnnotations(MyAnnotation.<jk>class</jk>).toList();
 * </p>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='jc'>{@link ClassInfo} - Class introspection
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauCommonsReflection">Reflection Package</a>
 * </ul>
 */
@SuppressWarnings({
   "java:S1192" // Duplicated literals (argument/property names) read more clearly inline than as constants
})
public class PackageInfo implements Annotatable {

   //-----------------------------------------------------------------------------------------------------------------
   // Static
   //-----------------------------------------------------------------------------------------------------------------

   private static final Cache<Package,PackageInfo> CACHE = Cache.of(Package.class, PackageInfo.class).build();

   /**
    * Returns a package info wrapper around the package of the specified class.
    *
    * @param childClass The class whose package to retrieve.  Must not be <jk>null</jk>.
    * @return A package info wrapper.
    */
   public static PackageInfo of(Class<?> childClass) {
      return of(childClass.getPackage());
   }

   /**
    * Returns a package info wrapper around the package of the specified class info.
    *
    * @param childClass The class info whose package to retrieve.  Must not be <jk>null</jk>.
    * @return A package info wrapper.
    */
   public static PackageInfo of(ClassInfo childClass) {
      return childClass.getPackage();
   }

   /**
    * Returns a package info wrapper around the specified package object.
    *
    * @param inner The package object.  Must not be <jk>null</jk>.
    * @return A package info wrapper.
    */
   public static PackageInfo of(Package inner) {
      return CACHE.get(inner, () -> new PackageInfo(inner));
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Instance
   //-----------------------------------------------------------------------------------------------------------------

   private final Package inner;
   private final Supplier<List<AnnotationInfo<Annotation>>> annotations;  // All annotations on this package, wrapped in AnnotationInfo. Repeated annotations have been unwrapped and are present as individual instances.

   /**
    * Constructor.
    *
    * @param inner The package object.  Must not be <jk>null</jk>.
    */
   protected PackageInfo(Package inner) {
      reqnn("inner", inner);
      this.inner = inner;
      this.annotations = memoize(
         () -> o(inner).map(pkg -> stream(pkg.getAnnotations()).flatMap(AnnotationUtils::streamRepeated).map(a -> AnnotationInfo.of(this, a)).toList()).orElse(emptyList()));
   }

   /**
    * Returns <jk>true</jk> if the specified object is equal to this package.
    *
    * <p>
    * Two packages are equal if they have the same name.
    *
    * @param obj The object to compare to.
    * @return <jk>true</jk> if the specified object is equal to this package.
    */
   @Override /* Object */
   public boolean equals(Object obj) {
      if (obj instanceof PackageInfo obj2)
         return inner.equals(obj2.inner);
      return inner.equals(obj);
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Package methods
   //-----------------------------------------------------------------------------------------------------------------

   @Override /* Annotatable */
   public AnnotatableType getAnnotatableType() { return AnnotatableType.PACKAGE_TYPE; }

   /**
    * Returns all annotations on this package, wrapped in {@link AnnotationInfo} objects.
    *
    * <p>
    * Cached and unmodifiable.
    * Repeated annotations (from {@code @Repeatable} containers) have been automatically unwrapped and are present as individual instances in the list.
    *
    * @return All annotations present on this package, or an empty list if there are none.
    */
   public List<AnnotationInfo<Annotation>> getAnnotations() { return annotations.get(); }

   /**
    * Returns this package's annotations of the specified type (including repeated annotations), wrapped in {@link AnnotationInfo}.
    *
    * <p>
    * Filters the cached annotations list by type.
    *
    * @param <A> The annotation type.
    * @param type The annotation type.
    * @return A stream of annotation infos of the specified type, never <jk>null</jk>.
    */
   @SuppressWarnings({
      "unchecked" // Type erasure requires cast for annotation stream
   })
   public <A extends Annotation> Stream<AnnotationInfo<A>> getAnnotations(Class<A> type) {
      return getAnnotations().stream().filter(ai -> type.isInstance(ai.inner())).map(ai -> (AnnotationInfo<A>)ai);
   }

   /**
    * Returns the title of this package's implementation.
    *
    * <p>
    * Same as calling {@link Package#getImplementationTitle()}.
    *
    * @return The implementation title, or <jk>null</jk> if it is not known.
    * @see Package#getImplementationTitle()
    */
   public String getImplementationTitle() { return inner.getImplementationTitle(); }

   /**
    * Returns the name of the organization that provided this package's implementation.
    *
    * <p>
    * Same as calling {@link Package#getImplementationVendor()}.
    *
    * @return The implementation vendor, or <jk>null</jk> if it is not known.
    * @see Package#getImplementationVendor()
    */
   public String getImplementationVendor() { return inner.getImplementationVendor(); }

   /**
    * Returns the version of this package's implementation.
    *
    * <p>
    * Same as calling {@link Package#getImplementationVersion()}.
    *
    * @return The implementation version, or <jk>null</jk> if it is not known.
    * @see Package#getImplementationVersion()
    */
   public String getImplementationVersion() { return inner.getImplementationVersion(); }

   @Override /* Annotatable */
   public String getLabel() { return getName(); }

   /**
    * Returns the name of this package.
    *
    * <p>
    * Same as calling {@link Package#getName()}.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bjava'>
    *    PackageInfo <jv>pi</jv> = PackageInfo.<jsm>of</jsm>(String.<jk>class</jk>);
    *    String <jv>name</jv> = <jv>pi</jv>.getName();  <jc>// "java.lang"</jc>
    * </p>
    *
    * @return The fully-qualified name of this package.
    * @see Package#getName()
    */
   public String getName() { return inner.getName(); }

   /**
    * Returns the title of the specification that this package implements.
    *
    * <p>
    * Same as calling {@link Package#getSpecificationTitle()}.
    *
    * @return The specification title, or <jk>null</jk> if it is not known.
    * @see Package#getSpecificationTitle()
    */
   public String getSpecificationTitle() { return inner.getSpecificationTitle(); }

   /**
    * Returns the name of the organization that maintains the specification implemented by this package.
    *
    * <p>
    * Same as calling {@link Package#getSpecificationVendor()}.
    *
    * @return The specification vendor, or <jk>null</jk> if it is not known.
    * @see Package#getSpecificationVendor()
    */
   public String getSpecificationVendor() { return inner.getSpecificationVendor(); }

   /**
    * Returns the version number of the specification that this package implements.
    *
    * <p>
    * Same as calling {@link Package#getSpecificationVersion()}.
    *
    * <p>
    * This version string must be a sequence of nonnegative decimal integers separated by periods
    * and may have leading zeros.
    *
    * @return The specification version, or <jk>null</jk> if it is not known.
    * @see Package#getSpecificationVersion()
    */
   public String getSpecificationVersion() { return inner.getSpecificationVersion(); }

   /**
    * Returns the hash code of this package.
    *
    * <p>
    * Same as calling {@link Package#hashCode()}.
    *
    * @return The hash code of this package.
    */
   @Override /* Object */
   public int hashCode() {
      return inner.hashCode();
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Object methods
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Returns the wrapped {@link Package} object.
    *
    * @return The wrapped {@link Package} object.
    */
   public Package inner() {
      return inner;
   }

   /**
    * Compares this package's specification version with a desired version.
    *
    * <p>
    * Same as calling {@link Package#isCompatibleWith(String)}.
    *
    * <p>
    * The version strings are compared by comparing each decimal integer in the version string.
    *
    * @param desired The desired version.
    * @return <jk>true</jk> if this package's specification version is compatible with the desired version.
    * @throws NumberFormatException If the desired or current version is not in the correct format.
    * @see Package#isCompatibleWith(String)
    */
   public boolean isCompatibleWith(String desired) throws NumberFormatException {
      return inner.isCompatibleWith(desired);  // HTT - Hard to test normal return path: requires package with version set in JAR manifest (Specification-Version header), which is difficult to set in test environment
   }

   /**
    * Returns <jk>true</jk> if this package is sealed.
    *
    * <p>
    * Same as calling {@link Package#isSealed()}.
    *
    * @return <jk>true</jk> if this package is sealed.
    * @see Package#isSealed()
    */
   public boolean isSealed() { return inner.isSealed(); }

   //-----------------------------------------------------------------------------------------------------------------
   // Annotatable interface methods
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Returns <jk>true</jk> if this package is sealed with respect to the specified code source URL.
    *
    * <p>
    * Same as calling {@link Package#isSealed(URL)}.
    *
    * @param url The code source URL.
    * @return <jk>true</jk> if this package is sealed with respect to the specified URL.
    * @see Package#isSealed(URL)
    */
   public boolean isSealed(URL url) {
      return inner.isSealed(url);
   }

   /**
    * Returns the string representation of this package.
    *
    * <p>
    * Same as calling {@link Package#toString()}.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bjava'>
    *    PackageInfo <jv>pi</jv> = PackageInfo.<jsm>of</jsm>(String.<jk>class</jk>);
    *    String <jv>s</jv> = <jv>pi</jv>.toString();  <jc>// "package java.lang"</jc>
    * </p>
    *
    * @return The string representation of this package.
    * @see Package#toString()
    */
   @Override /* Object */
   public String toString() {
      return inner.toString();
   }
}