001    /**
002     * Copyright (C) 2009-2011 the original author or authors.
003     * See the notice.md file distributed with this work for additional
004     * information regarding copyright ownership.
005     *
006     * Licensed under the Apache License, Version 2.0 (the "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.fusesource.restygwt.client;
020    
021    import java.lang.annotation.Documented;
022    import java.lang.annotation.Retention;
023    import java.lang.annotation.Target;
024    
025    import static java.lang.annotation.ElementType.*;
026    import static java.lang.annotation.RetentionPolicy.RUNTIME;
027    import static org.fusesource.restygwt.client.Json.Style.DEFAULT;
028    
029    @Documented
030    @Retention(RUNTIME)
031    @Target( { METHOD, TYPE })
032    public @interface Options {
033    
034        Class<? extends Dispatcher> dispatcher() default Dispatcher.class;
035    
036        /**
037         * sets the expected response status code.  If the response status code does not match
038         * any of the values specified then the request is considered to have failed.  Defaults to accepting
039         * 200,201,204. If set to -1 then any status code is considered a success.
040         */
041        int[] expect() default {};
042    
043        /**
044         * Sets the number of milliseconds to wait for a request to complete.  A value of zero disables timeouts.
045         *
046         * @return
047         */
048        long timeout() default -1;
049    }