1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.hc.core5.http2.frame;
28
29 /**
30 * Abstract HTTP/2 data frame.
31 *
32 * @since 5.0
33 *
34 * @param <T> frame payload representation.
35 */
36 public abstract class Frame<T> {
37
38 private final int type;
39 private final int flags;
40 private final int streamId;
41
42 public Frame(final int type, final int flags, final int streamId) {
43 this.type = type;
44 this.flags = flags;
45 this.streamId = streamId;
46 }
47
48 public boolean isType(final FrameType type) {
49 return getType() == type.value;
50 }
51
52 public boolean isFlagSet(final FrameFlag flag) {
53 return (getFlags() & flag.value) != 0;
54 }
55
56 public int getType() {
57 return type;
58 }
59
60 public int getFlags() {
61 return flags;
62 }
63
64 public int getStreamId() {
65 return streamId;
66 }
67
68 public abstract T getPayload();
69
70 @Override
71 public String toString() {
72 final StringBuilder sb = new StringBuilder("[");
73 sb.append("type=").append(type);
74 sb.append(", flags=").append(flags);
75 sb.append(", streamId=").append(streamId);
76 sb.append(", payoad=").append(getPayload());
77 sb.append(']');
78 return sb.toString();
79 }
80
81 }