001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.protocol.ws.api.event;
018
019import org.apache.wicket.protocol.ws.api.WebSocketRequestHandler;
020import org.apache.wicket.protocol.ws.api.message.TextMessage;
021import org.apache.wicket.util.lang.Args;
022
023/**
024 * A event broadcasting payload for the case when a text message arrives in the
025 * WebSocket connection
026 *
027 * @since 6.0
028 */
029public class WebSocketTextPayload extends WebSocketPayload<TextMessage>
030{
031        private final TextMessage data;
032        
033        public WebSocketTextPayload(TextMessage data, WebSocketRequestHandler handler)
034        {
035                super(handler);
036
037                this.data = Args.notNull(data, "data");
038        }
039
040        @Override
041        public final TextMessage getMessage()
042        {
043                return data;
044        }
045
046}