1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.apache.giraph.comm.messages;
20
21 import org.apache.giraph.conf.ImmutableClassesGiraphConfiguration;
22 import org.apache.giraph.conf.MessageClasses;
23 import org.apache.hadoop.io.Writable;
24 import org.apache.hadoop.io.WritableComparable;
25
26 /**
27 * Factory for message stores
28 *
29 * @param <I> Vertex id
30 * @param <M> Message data
31 * @param <MS> Message store
32 */
33 public interface MessageStoreFactory<I extends WritableComparable,
34 M extends Writable, MS> {
35 /**
36 * Creates new message store.
37 *
38 * @param messageClasses Message classes information to be held in the store
39 * @return New message store
40 */
41 MS newStore(MessageClasses<I, M> messageClasses);
42
43 /**
44 * Implementation class should use this method of initialization
45 * of any required internal state.
46 *
47 * @param partitionInfo Partition split info
48 * @param conf Configuration
49 */
50 void initialize(PartitionSplitInfo<I> partitionInfo,
51 ImmutableClassesGiraphConfiguration<I, ?, ?> conf);
52 }