← Back to branch summary

~steve-evolvedlight/opensatnav/buildfix

« back to all changes in this revision

Viewing changes to src/org/opensatnav/contribute/content/DescriptionGenerator.java

  • Committer: evolvedlight
  • Date: 2010-06-08 15:16:00 UTC
  • mfrom: (153.1.3 opensatnav)
  • Revision ID: steve@evolvedlight.co.uk-20100608151600-z9c23wzmn9h6zvyu
I gotta learn bzr better...

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org/opensatnav/contribute/content/DescriptionGenerator.java
 
1
/*
 
2
 * Copyright 2010 Google Inc.
 
3
 * 
 
4
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 
5
 * use this file except in compliance with the License. You may obtain a copy of
 
6
 * the License at
 
7
 * 
 
8
 * http://www.apache.org/licenses/LICENSE-2.0
 
9
 * 
 
10
 * Unless required by applicable law or agreed to in writing, software
 
11
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 
12
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 
13
 * License for the specific language governing permissions and limitations under
 
14
 * the License.
 
15
 */
 
16
package org.opensatnav.contribute.content;
 
17
 
 
18
import java.util.Vector;
 
19
 
 
20
/**
 
21
 * An interface for an object that can generate descriptions of waypoints.
 
22
 * 
 
23
 * @author Sandor Dornbush
 
24
 */
 
25
public interface DescriptionGenerator {
 
26
  
 
27
  /**
 
28
   * Generate a description of the waypoint.
 
29
   */
 
30
  public String generateWaypointDescription(Waypoint waypoint);
 
31
  
 
32
  /**
 
33
   * Generates a description for a track (with information about the
 
34
   * statistics).
 
35
   *
 
36
   * @param track the track
 
37
   * @return a track description
 
38
   */
 
39
  public String generateTrackDescription(Track track, Vector<Double> distances,
 
40
      Vector<Double> elevations);
 
41
}