org.apache.fop.datatypes.KeepValue Maven / Gradle / Ivy

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

Tool to convert CSV and XLS to XML, to transform XML and to convert XML to CSV, HTML, other text files, PDF etc., useful as command line tool and integrated in other projects.

There is a newer version: 3.119

Show newest version

/*
 * 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.
 */

/* $Id: KeepValue.java 1610839 2014-07-15 20:25:58Z vhennebert $ */

package org.apache.fop.datatypes;

/**
 * Keep Value
 * Stores the different types of keeps in a single convenient format.
 */
public class KeepValue {
    /** constant for keep-with-always */
    public static final String KEEP_WITH_ALWAYS = "KEEP_WITH_ALWAYS";
    /** constant for automatic keep-with computation */
    public static final String KEEP_WITH_AUTO = "KEEP_WITH_AUTO";
    /** constant for a user-settable keep-with value (??) */
    public static final String KEEP_WITH_VALUE = "KEEP_WITH_VALUE";
    private String type = KEEP_WITH_AUTO;
    private int value;

    /**
     * Constructor
     * @param type one of "KEEP_WITH_ALWAYS", "KEEP_WITH_AUTO", or
     * "KEEP_WITH_VALUE"
     * @param val keep-with value to use (used only by KEEP_WITH_VALUE ??).
     */
    public KeepValue(String type, int val) {
        this.type = type;
        this.value = val;
    }

    /**
     * @return the keep-with value
     */
    public int getValue() {
        return value;
    }

    /**
     * @return the descriptive type
     */
    public String getType() {
        return type;
    }

    /**
     * @return string representation of this
     */
    public String toString() {
        return type;
    }

}