/*
    * 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.rat.analysis;
  
  import org.apache.rat.license.ILicense;
  import org.apache.rat.license.ILicenseFamily;
  
  /**
   * An ILicense implementation that represents an unknown license.
   * <p>
   * The UnknownLicense is used during processing to report that a document
   * license can not be determined.
   */
  public final class UnknownLicense implements ILicense {
  
      /**
       * The single instance of this class.
       */
      public static final UnknownLicense INSTANCE = new UnknownLicense();
  
      /**
       * The license family for the unknown license.
       */
      private final ILicenseFamily family;
  
      /**
       * Do not allow other constructions.
       */
      private UnknownLicense() {
          family = ILicenseFamily.UNKNOWN;
      }
  
      @Override
      public String getId() {
          return family.getFamilyCategory();
      }
  
      @Override
      public void reset() {
          // do nothing
      }
  
      @Override
      public boolean matches(final IHeaders headers) {
          return false;
      }
  
      @Override
      public boolean equals(final Object o) {
          return super.equals(o);
      }
  
      @Override
      public int hashCode() {
          return family.hashCode();
      }
  
      @Override
      public ILicenseFamily getLicenseFamily() {
          return family;
      }
  
      @Override
      public String getNote() {
          return null;
      }
  
      @Override
      public String getName() {
          return family.getFamilyName();
      }
  
      @Override
      public IHeaderMatcher getMatcher() {
          return null;
      }
  }