org.cp.elements.data.struct.tabular.support.BeanPropertyToTableColumnResolver Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development. Write better Java!

The newest version!

/*
 * 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.data.struct.tabular.support;

import java.util.Optional;

import org.cp.elements.beans.Bean;
import org.cp.elements.beans.model.Property;
import org.cp.elements.data.struct.tabular.Column;
import org.cp.elements.data.struct.tabular.Table;
import org.cp.elements.data.struct.tabular.View;
import org.cp.elements.text.FormatUtils;

/**
 * Interface defining a contract for resolving a {@link Table} or {@link View} {@link Column} for a given,
 * required {@link Bean} {@link Property}.
 *
 * @author John Blum
 * @see org.cp.elements.beans.Bean
 * @see org.cp.elements.beans.model.Property
 * @see org.cp.elements.data.struct.tabular.Column
 * @see org.cp.elements.data.struct.tabular.Table
 * @see org.cp.elements.data.struct.tabular.View
 * @since 1.0.2
 */
@FunctionalInterface
@SuppressWarnings("unused")
public interface BeanPropertyToTableColumnResolver {

  /**
   * Requires a {@link Table} {@link Column} to be resolvable from the given {@link Bean} {@link Property}.
   *
   * @param beanProperty {@link Bean} {@link Property} used to resolve the {@link Table} {@link Column}.
   * @return the {@link Table} {@link Column} resolved from the given {@link Bean} {@link Property}.
   * @throws ColumnNotFoundException if a {@link Table} {@link Column} cannot be resolved from
   * the given {@link Bean} {@link Property}.
   * @see org.cp.elements.data.struct.tabular.Column
   * @see org.cp.elements.beans.model.Property
   * @see #resolve(Property)
   */
  default Column require(Property beanProperty) {
    return this.resolve(beanProperty)
      .orElseThrow(() -> new ColumnNotFoundException(
        FormatUtils.format("Table column for bean property [%s] was not found", beanProperty)));
  }

  /**
   * Resolves a {@link Table} {@link Column} from an given, required {@link Bean} {@link Property}.
   *
   * @param beanProperty {@link Bean} {@link Property} to resolve into a {@link Table} {@link Column}.
   * @return the resolved {@link Table} {@link Column} from the given, required {@link Bean} {@link Property}.
   * @see org.cp.elements.data.struct.tabular.Column
   * @see org.cp.elements.beans.model.Property
   * @see java.util.Optional
   */
  Optional> resolve(Property beanProperty);

}