/*
 * Copyright (c) Facebook, Inc. and 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.
 */

package com.facebook.buck.core.starlark.compatible;

/**
 * Thrown when trying to construct an Immutable Skylark object from a Mutable one (that cannot be
 * made immutable. i.e. it is not a list or dictionary)
 */
public class MutableObjectException extends RuntimeException {
  private final Object mutableObject;

  public MutableObjectException(Object mutableObject) {
    super(String.format("%s was still mutable", mutableObject));
    this.mutableObject = mutableObject;
  }

  /**
   * @return the object that is mutable. This can be useful when the mutable object was deep in a
   *     hierarchy
   */
  public Object getMutableObject() {
    return mutableObject;
  }
}
