PageRenderTime 10ms CodeModel.GetById 1ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/NetworkPkg/NetworkJitPrpt.java

http://mobicents.googlecode.com/
Java | 96 lines | 32 code | 12 blank | 52 comment | 0 complexity | b0e77bca3bf692f036b084474c989147 MD5 | raw file
 1package javax.megaco.pkg.NetworkPkg;
 2
 3import javax.megaco.message.DescriptorType;
 4import javax.megaco.pkg.MegacoPkg;
 5import javax.megaco.pkg.ParamValueType;
 6import javax.megaco.pkg.PkgPrptyItem;
 7
 8/**
 9 * The MEGACO Maximum Jitter Buffer property class extends the PkgPrptyItem
10 * class. This is a final class. This class defines Maximum Jitter Buffer
11 * property of Network package. The methods shall define that this property item
12 * belongs to the Network package.
13 */
14public final class NetworkJitPrpt extends PkgPrptyItem {
15
16	/**
17	 * Identifies Maximum jitter buffer property of the MEGACO Network Package.
18	 * Its value shall be set equal to 0x0007.
19	 */
20	public static final int NETWORK_JIT_PRPT = 0x0007;
21
22	protected int[] itemsDescriptorIds = null;
23
24	/**
25	 * Constructs a Jain MEGACO Object representing property Item of the MEGACO
26	 * Package for property Maximum Jitter Buffer and Package as Network.
27	 */
28	public NetworkJitPrpt() {
29		super();
30		super.itemId = NETWORK_JIT_PRPT;
31		super.propertyId = NETWORK_JIT_PRPT;
32		super.packageId = new NetworkPkg();
33		super.itemValueType = ParamValueType.M_INTEGER;
34		itemsDescriptorIds = new int[] { DescriptorType.M_LOCAL_CONTROL_DESC };
35	}
36
37	/**
38	 * This method is used to get the item identifier from an Item object. The
39	 * implementations of this method in this class returns the id of the Jitter
40	 * statistics of Network Package.
41	 * 
42	 * @return It shall return {@link NetworkJitPrpt.NETWORK_JIT_PRPT}.
43	 */
44	public int getItemId() {
45		return super.itemId;
46	}
47
48	/**
49	 * The method can be used to get the type of the value as defined in the
50	 * MEGACO packages. These could be one of string or enumerated value or
51	 * integer or double value or boolean.
52	 * 
53	 * @return It returns {@link ParamValueType.M_INTEGER}
54	 *         indicating that the parameter is a double.
55	 */
56	public int getItemValueType() {
57		return itemValueType;
58	}
59
60	/**
61	 * This method is used to get the statistics identifier from an Statistics
62	 * Item object. The implementations of this method in this class returns the
63	 * id of the Jitter statistics of Network Package.
64	 * 
65	 * @return It shall return {@link NetworkJitPrpt.NETWORK_JIT_PRPT}.
66	 */
67	public int getPropertyId() {
68		return super.propertyId;
69	}
70
71	/**
72	 * This method gets the package id to which the item belongs. Since the
73	 * Jitter property is defined in the Network Package of MEGACO protocol,
74	 * this method returns the value NETWORK_PACKAGE constant. This constant is
75	 * defined in the PkgConsts class.
76	 * 
77	 * @return The package id {@link NetworkPkg.NETWORK_PACKAGE}.
78	 */
79	public MegacoPkg getItemsPkgId() {
80
81		return super.packageId;
82	}
83
84	/**
85	 * The method can be used to get the descriptor ids corresponding to the
86	 * parameters to which the parameter can be set.
87	 * 
88	 * @return This parameter can be present in Event descriptor. It shall thus
89	 *         return a value {@link DescriptorType.M_LOCAL_CONTROL_DESC} as a
90	 *         part of integer vector.
91	 */
92	public int[] getItemsDescriptorIds() {
93		return this.itemsDescriptorIds;
94	}
95
96}