net.sf.jsqlparser.statement.select.Wait Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of embedded-server Show documentation

The newest version!

/*
 * #%L JSQLParser library %% Copyright (C) 2004 - 2017 JSQLParser %% This program is free software:
 * you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 2.1 of the License, or (at your
 * option) any later version. This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Lesser Public License for more details. You should have
 * received a copy of the GNU General Lesser Public License along with this program. If not, see
 * . #L%
 */
package net.sf.jsqlparser.statement.select;

/**
 * A timeout applied to SELECT to specify how long to wait for the row on the lock to be released.
 *
 * @author janmonterrubio
 */
public class Wait {

    private long timeout;

    /**
     * Returns the number of seconds specified for the WAIT command
     *
     * @return the number of seconds specified for the WAIT command
     */
    public long getTimeout() {
        return timeout;
    }

    /**
     * Sets the number of seconds to WAIT for this {@link Wait}
     *
     * @param timeout the number of seconds to WAIT for this {@link Wait}
     */
    public void setTimeout(long timeout) {
        this.timeout = timeout;
    }

    /**
     * Returns a String containing the WAIT clause and its timeout, where TIMEOUT is specified by
     * {@link #getTimeout()}. The returned string will null     be:
     * " WAIT <TIMEOUT>"
     * 
     */
    @Override
    public String toString() {
        return " WAIT " + timeout;
    }
}