// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tombstone

import "context"

type TombstoneSweeper interface {
	AddTombstone(tombstone Tombstone)
	Close()
}

// Tombstone is the interface for the tombstone.
type Tombstone interface {
	// ID returns the unique identifier of the tombstone.
	ID() string

	// ConfirmCanBeRemoved checks if the tombstone can be removed forever.
	ConfirmCanBeRemoved(ctx context.Context) (bool, error)

	// Remove removes the tombstone.
	Remove(ctx context.Context) error
}