/*
 * Copyright (C) 2023 Amazon.com, Inc. or its affiliates.
 *
 * Licensed 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.
 */

/**
 * An exception class conveying that an S3 object
 * is not a document, for instance, in the case
 * of a directory.
 */
export class InvalidDocumentObjectException extends Error {
  private key: string;

  constructor(key: string) {
    super(`Object is not a document: ${key}`);
    this.key = key;
  }

  /**
   * @returns the name of the object that is not
   * a document.
   */
  public getKey(): string {
    return (this.key);
  }
}
