org.cp.elements.lang.support.AbstractIdentifiable Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011-Present Author or Authors.
 *
 * 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 org.cp.elements.lang.support;

import org.cp.elements.lang.Constants;
import org.cp.elements.lang.Identifiable;

/**
 * {@link AbstractIdentifiable} is an abstract base class implementing the {@link Identifiable} interface
 * with default, no-op implementations of the interface methods by throwing an {@link UnsupportedOperationException}.
 *
 * @author John J. Blum
 * @param  {@link Class type} of the identifier.
 * @see java.lang.Comparable
 * @see org.cp.elements.lang.Identifiable
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public abstract class AbstractIdentifiable> implements Identifiable {

  @Override
  public T getId() {
    throw new UnsupportedOperationException(Constants.NOT_IMPLEMENTED);
  }
}