LineSegment

java.lang.Object
- Line
- - LineSegment

```
public class LineSegment
extends Line
```
Author:

Sameh Fakhouri
A line segment has two endpoints and lies on a line with the same slope. This class is a subclass of the Line class.

Field Summary

Fields
Modifier and Type	Field and Description
`private Point`	`p1` Point representing the first endpoint for the line segment
`private Point`	`p2` Point representing the second endpoint for the line segment

Constructor Summary

Constructors
Constructor and Description

LineSegment(Point p1, Point p2)
Constructor that accepts the two endpoints of the line segment.

Constructors
Constructor and Description
`LineSegment(Point p1, Point p2)` Constructor that accepts the two endpoints of the line segment.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Method to compare 'this' line segment for equality with the 'object' specified as a parameter.
`Point`	`getP1()` Getter for the first endpoint
`Point`	`getP2()` Getter for the second endpoint
`Point`	`intersection(Line line)` A method that computes and returns the Point intersection of 'this' line segment and the line specified in the parameter.
`Point`	`intersection(LineSegment lineSegment)` A method that computes and returns the Point of of intersection of 'this' line segment and the line segment specified in the parameter.
`double`	`length()` Method to compute the length of 'this' line segment.
`Point`	`midpoint()` Method to compute the midpoint of 'this' line segment
`boolean`	`oneCommonEndpoint(LineSegment lineSegment)` Method that checks if 'this' line segment has one common end-point with the specified line segment.
`boolean`	`pointIsOnLineSegment(Point p)` This method is called to find if the specified Point lies on 'this' line segment.
`void`	`setP1(Point p1)` Setter to change the first endpoint
`void`	`setP2(Point p2)` Setter to change the first endpoint
`java.lang.String`	`toString()` Method to render 'this' instance of the LineSegment class into a String.

Methods inherited from class Line
getSlope, getyIntercept, isParallelTo, isPerpendicularTo, pointIsOnTheLine, setSlope, setyIntercept, updateLine

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - p1
```
private Point p1
```
    Point representing the first endpoint for the line segment
  - p2
```
private Point p2
```
    Point representing the second endpoint for the line segment
- Constructor Detail
  - LineSegment
```
public LineSegment(Point p1,
                   Point p2)
```
    Constructor that accepts the two endpoints of the line segment. Since the LineSegment class extends the Line class, you must have a call to the super constructor at the beginning of this constructor.
    
    Parameters:
    
    p1 - Point representing one endpoint of the line segment
    
    p2 - Point representing the other endpoint of the line segment
- Method Detail
  - getP1
```
public Point getP1()
```
    Getter for the first endpoint
    
    Returns:
    
    A Point representing the first endpoint of the line segment
  - setP1
```
public void setP1(Point p1)
```
    Setter to change the first endpoint
    
    Parameters:
    
    p1 - A Point representing the new first enpoint of the line segment
  - getP2
```
public Point getP2()
```
    Getter for the second endpoint
    
    Returns:
    
    A Point representing the second endpoint of the line segment
  - setP2
```
public void setP2(Point p2)
```
    Setter to change the first endpoint
    
    Parameters:
    
    p2 - A Point representing the new first enpoint of the line segment
  - pointIsOnLineSegment
```
public boolean pointIsOnLineSegment(Point p)
```
    This method is called to find if the specified Point lies on 'this' line segment.
    
    Parameters:
    
    p - The point we are checking to see if it lies on the 'this' line segment.
    
    Returns:
    
    Returns true if the specified Point lies on 'this' line segment. Returns false otherwise.
  - intersection
```
public Point intersection(Line line)
```
    A method that computes and returns the Point intersection of 'this' line segment and the line specified in the parameter. Please note that parallel and equal lines do not have a Point of intersection. Also, even if there is an intersection of the underlying lines, the point should lie on 'this' line segment for the intersection to be valid.
    
    Overrides:
    
    intersection in class Line
    
    Parameters:
    
    line - The line for which we are computing the intersection with 'this' line.
    
    Returns:
    
    An instance of the Point class which represents the intersection of 'this' line segment and the line specified as a parameter. If no intersection exists, return null
  - intersection
```
public Point intersection(LineSegment lineSegment)
```
    A method that computes and returns the Point of of intersection of 'this' line segment and the line segment specified in the parameter. Please note that even if there is an intersection of the underlying lines, the point should lie on both line segments for the intersection to be valid
    
    Parameters:
    
    lineSegment - The line segment for which we are computing the intersection with 'this' line segment.
    
    Returns:
    
    An instance of the Point class which represents the intersection of 'this' line segment and the line segment specified as a parameter. If no intersection exists, return null
  - oneCommonEndpoint
```
public boolean oneCommonEndpoint(LineSegment lineSegment)
```
    Method that checks if 'this' line segment has one common end-point with the specified line segment. Please note that if the two line segments are equal, this method must return false since we are checking for only one common end-point
    
    Parameters:
    
    lineSegment - The line segment for which we are checking for a common end-point with 'this' line segment.
    
    Returns:
    
    true if there is, at most, one common end-point between the two line segments. returns false otherwise.
  - length
```
public double length()
```
    Method to compute the length of 'this' line segment.
    
    Returns:
    
    A double value representing the length of 'this' line segment
  - midpoint
```
public Point midpoint()
```
    Method to compute the midpoint of 'this' line segment
    
    Returns:
    
    A Point representing the midpoint of 'this' line segment
  - equals
```
public boolean equals(java.lang.Object object)
```
    Method to compare 'this' line segment for equality with the 'object' specified as a parameter.
    
    Overrides:
    
    equals in class Line
    
    Parameters:
    
    object - An Object to be tested for equality with 'this' line segment
    
    Returns:
    
    Returns true if the specified 'object' is a LineSegment with the same endpoints as 'this' LineSegment. Returns false otherwise.
  - toString
```
public java.lang.String toString()
```
    Method to render 'this' instance of the LineSegment class into a String.
    
    Overrides:
    
    toString in class Line
    
    Returns:
    
    Returns the String this.p1 + "-----" + this.p2

Class LineSegment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Line

Methods inherited from class java.lang.Object

Field Detail

p1

p2

Constructor Detail

LineSegment

Method Detail

getP1

setP1

getP2

setP2

pointIsOnLineSegment

intersection

intersection

oneCommonEndpoint

length

midpoint

equals

toString