All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.modelmapper.spi.ValueReader Maven / Gradle / Ivy

Go to download

There is a newer version: 3.2.1
Show newest version
/*
 * Copyright 2013 the original 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.modelmapper.spi;

import java.util.Collection;

/**
 * Reads values from a source. Allows for integration with 3rd party libraries.
 * 
 * @param  source type
 * @author Jonathan Halterman
 */
public interface ValueReader {
  /**
   * Returns the value from the {@code source} object for the {@code memberName}.
   * 
   * @throws IllegalArgumentException if the {@code memberName} is invalid for the {@code source}
   */
  Object get(T source, String memberName);

  /**
   * Returns the {@link Member} from the {@code source} within given {@code memberName}.
   *
   * @param source the source object
   * @param memberName the name of member
   */
  Member getMember(T source, String memberName);

  /**
   * Returns all member names for the {@code source} object, else {@code null} if the source has no
   * members.
   */
  Collection memberNames(T source);


  /**
   * A member of a given source
   *
   * @param  source type
   */
  abstract class Member {
    private Class valueType;

    /**
     * Creates a member contains nested value
     *
     * @param valueType the value type
     */
    @SuppressWarnings("unchecked")
    public Member(Class valueType) {
      this.valueType = (Class) valueType;
    }

    public Class getValueType() {
      return valueType;
    }

    /**
     * The origin value of this member
     *
     * @return the origin value
     */
    public T getOrigin() {
      return null;
    }

    /**
     * Get the member from the source with given member name.
     *
     * @param source the source
     * @param memberName the member name
     * @return the member of the source
     */
    public abstract Object get(T source, String memberName);
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy