github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/controller/graph/plan_builder.go (about)

     1  /*
     2  Copyright (C) 2022-2023 ApeCloud Co., Ltd
     3  
     4  This file is part of KubeBlocks project
     5  
     6  This program is free software: you can redistribute it and/or modify
     7  it under the terms of the GNU Affero General Public License as published by
     8  the Free Software Foundation, either version 3 of the License, or
     9  (at your option) any later version.
    10  
    11  This program is distributed in the hope that it will be useful
    12  but WITHOUT ANY WARRANTY; without even the implied warranty of
    13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14  GNU Affero General Public License for more details.
    15  
    16  You should have received a copy of the GNU Affero General Public License
    17  along with this program.  If not, see <http://www.gnu.org/licenses/>.
    18  */
    19  
    20  package graph
    21  
    22  // PlanBuilder builds a Plan by applying a group of Transformer to an empty DAG.
    23  type PlanBuilder interface {
    24  	// Init loads the primary object to be reconciled, and does meta initialization
    25  	Init() error
    26  
    27  	// AddTransformer adds transformers to the builder in sequence order.
    28  	// And the transformers will be executed in the add order.
    29  	AddTransformer(transformer ...Transformer) PlanBuilder
    30  
    31  	// AddParallelTransformer adds transformers to the builder.
    32  	// And the transformers will be executed in parallel.
    33  	AddParallelTransformer(transformer ...Transformer) PlanBuilder
    34  
    35  	// Build runs all the transformers added by AddTransformer and/or AddParallelTransformer.
    36  	Build() (Plan, error)
    37  }
    38  
    39  // Plan defines the final actions should be executed.
    40  type Plan interface {
    41  	// Execute the plan
    42  	Execute() error
    43  }