src/java/org/apache/sqoop/lib/FieldMappable.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.sqoop.lib;

import java.util.Map;

/**
 * Interface describing a class capable of returning a map of the fields
 * of the object to their values.
 */
public interface FieldMappable {

  /**
   * Returns a map containing all fields of this record.
   * @return a map from column names to the object-based values for
   * this record. The map may not be null, though it may be empty.
   */
  Map<String, Object> getFieldMap();
}