blob: b6a28c1560f83f7160697bdaf15c92c69947ec13 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* 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 com.vaadin.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.vaadin.shared.communication.PushMode;
import com.vaadin.shared.ui.ui.Transport;
import com.vaadin.ui.UI;
/**
* Configures server push for a {@link UI}. Adding <code>@Push</code> to a UI
* class configures the UI for automatic push. If some other push mode is
* desired, it can be passed as a parameter, e.g.
* <code>@Push(PushMode.MANUAL)</code>.
*
* @see PushMode
*
* @author Vaadin Ltd.
* @since 7.1
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Push {
/**
* Returns the {@link PushMode} to use for the annotated UI. The default
* push mode when this annotation is present is {@link PushMode#AUTOMATIC}.
*
* @return the push mode to use
*/
public PushMode value() default PushMode.AUTOMATIC;
/**
* Returns the transport type used for the push for the annotated UI. The
* default transport type when this annotation is present is
* {@link Transport#WEBSOCKET}.
*
* @return the transport type to use
*/
public Transport transport() default Transport.WEBSOCKET;
}
|
